Samples: About to convert .md into .rst

samples/Basic_SmartConfig/README.md

@@ -1,3 +1,7 @@
+# Smart Config sample
+
+## Introduction
+
 SmartConfig is a mechanism to configure a device as quickly as possible with the intermediate help of a smart phone
 and with least interaction from a human as possible.
 

samples/Basic_Ssl/README.md

@@ -1,4 +1,7 @@
-# Compilation
+# Basic SSL sample
+
+## Compilation
+
 In Sming the SSL support is not enabled by default.
 
 In order to enable it you should first recompile SmingFramework with *ENABLE_SSL=1* directive.
@@ -22,7 +25,8 @@ make ENABLE_SSL=1
 
 Now you can flash your application to your ESP8266 device.
 
-# Debug Information
+## Debug Information
+
 If you want to see more debug information during compile type you should 
 add the directive *SSL_DEBUG=1*. A recompilation of SmingFramework with SSL support
 and SSL dubug information can be done with the following commands:
@@ -34,7 +38,8 @@ make clean
 make ENABLE_SSL=1 SSL_DEBUG=1
 ```
 
-# Slow SSL negotiation
+## Slow SSL negotiation
+
 The initial SSL negotiation is CPU intensive. By default SmingFramework switches the CPU
 frequency from 80 to 160 MHz. After the negotiation the CPU is switched back to 80 MHz.
 

samples/Basic_WebSkeletonApp/README.md

@@ -1,3 +1,7 @@
+# Basic Web Skeleton sample
+
+## Introduction
+
 Basic application that can be used as a start point for some useful App.
 
 Features:

samples/Basic_WebSkeletonApp_LTS/README.md

@@ -1,3 +1,7 @@
+# Basic Web Skeleton sample
+
+## Introduction
+
 Basic application that can be used as a start point for some useful App.
 
 Features:

samples/Basic_rBoot/readme.txt → samples/Basic_rBoot/README.md

@@ -1,5 +1,6 @@
-rBoot Sming sample
-------------------
+# rBoot Sming sample
+
+## Introduction
 
 This sample integrates rBoot and Sming, for the many people who have been asking
 for it. It demonstrates dual rom booting, big flash support, OTA updates and
@@ -15,8 +16,8 @@ Makefile-rboot.mk instead of Makefile-project.mk. In the sample the correct mk
 file is chosen automatically because of the setting RBOOT_ENABLED=1 in
 Makefile-user.mk
 
-Building
---------
+## Building
+
  1) Set ESP_HOME & SMING_HOME, as environment variables or edit Makefile-user.mk
     as you would for general Sming app compiling.
  2) Set ESPTOOL2 (env var or in Makefile-user.mk) to point to the esptool2
@@ -28,8 +29,8 @@ Building
  7) Put rom0.bin and spiff_rom.bin in the root of your webserver for OTA.
  8) Interact with the sample using a terminal, sorry no web-gui (yet).
 
-Flashing
---------
+## Flashing
+
 If flashing manually use esptool.py to flash rBoot, rom & spiffs e.g.:
  esptool.py --port <port> write_flash -fs 32m 0x00000 rboot.bin 0x02000 rom0.bin
    0x100000 spiffs.rom
@@ -38,22 +39,22 @@ Using the correct -fs parameter is important. This will be -fs 32m on an ESP12.
 
 You can also flash rom0.bin to 0x202000, but booting and using OTA is quicker!
 
-Technical Notes
----------------
+## Technical Notes
+
 spiffs_mount_manual(address, length) must be called from init. The address must
 be 0x40200000 + physical flash address. Sming does not use memory mapped flash
 so the reason for this strange addressing is not clear.
 
 Important compiler flags used:
-BOOT_BIG_FLASH - when using big flash mode, ensures flash mapping code is built
+* BOOT_BIG_FLASH - when using big flash mode, ensures flash mapping code is built
   in to the rom.
-RBOOT_INTEGRATION - ensures Sming specific options are pulled in to the rBoot
+* RBOOT_INTEGRATION - ensures Sming specific options are pulled in to the rBoot
   source at compile time.
-SPIFF_SIZE=value - passed through to code for mounting the filesystem. Also used
+* SPIFF_SIZE=value - passed through to code for mounting the filesystem. Also used
   in the Makefile to create the spiffs.
 
-Disabling big flash
--------------------
+## Disabling big flash
+
 If you want to use, for example, two 512k roms in the first 1mb block of flash
 (old style) then follow these instructions to produce two separately linked
 roms. If you are flashing a single rom to multiple 1mb flash blocks (using big
@@ -78,7 +79,7 @@ how to use this sample without bigflash support.
 If you want more than two roms you must be an advanced user and should be able
 to work out what to copy and edit to acheive this!
 
-Credits
--------
+## Credits
+
 This sample was made possible with the assistance of piperpilot, gschmott and
 robotiko on the esp8266.com forum.

samples/DFPlayerMini/readme.md → samples/DFPlayerMini/README.md

@@ -1,11 +1,15 @@
-# DFPlayer Mini
+# DFPlayer Mini sample
+
+## Introduction
+
 The DFPlayer Mini MP3 Player is a small and low price MP3 module with an simplified output directly to the speaker. The module can be used as a stand alone module with attached battery, speaker and push buttons or used in combination with an ESP8266 via RX/TX.
 
 For more details see this link: https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299
 
+## Building
+
 Steps to test this sample:
 * Connect DFPlayer Mini using RX/TX pins to TX/RX pins respectively of ESP8266.
 * Copy one or more mp3 file to an SD card. The example playes one file for some time and moves to next one.
 * Insert that SD card in the slot of the DF Player module.
 * Flash and run the sample code.
-

samples/Echo_Ssl/README.md

@@ -1,4 +1,7 @@
-# Compilation
+# Echo SSL sample
+
+## Compilation
+
 In Sming the SSL support is not enabled by default.
 
 In order to enable it you should first recompile SmingFramework with *ENABLE_SSL=1* directive.
@@ -22,7 +25,7 @@ make ENABLE_SSL=1
 
 Now you can flash your application to your ESP8266 device.
 
-# Debug Information
+## Debug Information
 If you want to see more debug information during compile type you should 
 add the directive *SSL_DEBUG=1*. A recompilation of SmingFramework with SSL support
 and SSL dubug information can be done with the following commands:
@@ -34,7 +37,7 @@ make clean
 make ENABLE_SSL=1 SSL_DEBUG=1
 ```
 
-# Slow SSL negotiation
+## Slow SSL negotiation
 The initial SSL negotiation is CPU intensive. By default SmingFramework switches the CPU
 frequency from 80 to 160 MHz. After the negotiation the CPU is switched back to 80 MHz.
 

samples/HttpClient/README.md

@@ -1,4 +1,6 @@
-# Compilation
+# HttpClient sample
+
+## Compilation
 In Sming the SSL support is not enabled by default.
 
 In order to enable it you should first recompile SmingFramework with *ENABLE_SSL=1* directive.
@@ -22,7 +24,7 @@ make ENABLE_SSL=1
 
 Now you can flash your application to your ESP8266 device.
 
-# Debug Information
+## Debug Information
 If you want to see more debug information during compile type you should 
 add the directive *SSL_DEBUG=1*. A recompilation of SmingFramework with SSL support
 and SSL dubug information can be done with the following commands:
@@ -34,7 +36,7 @@ make clean
 make ENABLE_SSL=1 SSL_DEBUG=1
 ```
 
-# Slow SSL negotiation
+## Slow SSL negotiation
 The initial SSL negotiation is CPU intensive. By default SmingFramework switches the CPU
 frequency from 80 to 160 MHz. After the negotiation the CPU is switched back to 80 MHz.
 

samples/HttpServer_ConfigNetwork/Readme.md → samples/HttpServer_ConfigNetwork/README.md

@@ -1,12 +1,14 @@
-# Introduction
+# HttpServer Config Network sample
+
+## Introduction
 
 The HTTP server coming with Sming is quite powerful but it is limited from the available resources of the underlining hardware (your favorite ESP8266 microcontroller). Serving multiple files at once can be problematic. It is not the size of the files that can cause problems, but the number of simultaneous files that need to be delivered. Therefore if you serve multiple CSS or JS files you can optimize your web application before uploading it into your ESP8266 using the advice below.
 
-# Optimizing File Delivery
+## Optimizing File Delivery
 
 In this example you will see how to combine CSS and JS files, compress them and deliver the optimized content via the HTTP server.
 
-## Installation
+### Installation
 
 The file optimization uses `gulp`. To install it and the needed gulp packages you need to install first [npm](https://www.npmjs.com/). 
 Npm is the Node.JS package manager.  Once you are done with the installation you can run from the command line the following:
@@ -15,7 +17,7 @@ Npm is the Node.JS package manager.  Once you are done with the installation you
 
  The command above will install gulp and its dependencies.
 
-## Usage
+### Usage
 
 During the development of your web application you should work only in the `web/dev/` folder. Once you are ready with the application you can `pack` the resources and `upload` them to your device. The commands are
 

samples/Humidity_SI7021/README.md

@@ -1,5 +1,6 @@
-# Sming 
-## SI7021 Example
+# SI7021 Humidity Sensor Example
+
+## Introduction
 
 Example code for I2C SI7021 sensor board
 
@@ -8,6 +9,6 @@ This code uses the following GPIO:
 * #define I2C_SCL 5 // SCL
 * #define I2C_SDA 4 // SCA
 
-# Build instructions
+## Build instructions
 
 Use `make` and `make flash` to build and flash the firmware to the ESP8266 board.

samples/LiquidCrystal_44780/README.md

@@ -1,5 +1,6 @@
-# Sming 
-## LiquidCrystal_44780 Example
+# LiquidCrystal 44780 Example
+
+## Introduction
 
 Example code for I2C LiquidCrystal LCDs
 
@@ -8,6 +9,6 @@ This code uses the following GPIO:
 * GPIO0 SCL
 * GPIO2 SDA
 
-# Build instructions
+## Build instructions
 
 Use `make` and `make flash` to build and flash the firmware to the ESP8266 board.

samples/LiveDebug/README.md

@@ -1,5 +1,4 @@
-LiveDebug
-=========
+# LiveDebug Sample
 
 This project is an example of how to integrate GDB debugging into your project.
 It provides a basic command interface which you can use via regular serial terminal or with the GDB application.
@@ -32,8 +31,8 @@ make flash ENABLE_CONSOLE=0
 
 Alternatively, use the `consoleOff` command from the GDB command prompt, then quit the debugger and connect via eclipse.
 
-Exception Handling
-------------------
+## Exception Handling
+
 Sming comes with a built-in exception handling that takes care to display the stack trace 
 leading to the issue. Usually it looks like this
 
@@ -88,8 +87,7 @@ and the sequence of commands might help us figure out the issue.
 
 But that information might not be enough. And finding the root cause may take quite some time.
 
-GDB Debugging
--------------
+## GDB Debugging
 
 Debugging is a powerful technique allowing you to interactively run your code and be able to see much more information about the things that went wrong.
 

samples/Pressure_BMP180/README.md

@@ -1,5 +1,6 @@
-# Sming 
-## BMP180 Example
+# BMP180 Pressure Sensor Example
+
+## Introduction
 
 Example code for I2C BMP180 sensor board
 
@@ -8,6 +9,6 @@ This code uses the following GPIO:
 * GPIO0 SCL
 * GPIO2 SDA
 
-# Build instructions
+## Build instructions
 
 Use `make` and `make flash` to build and flash the firmware to the ESP8266 board.

samples/SmtpClient/README.md

@@ -1,7 +1,10 @@
-# Purpose of this Sample Code
+# SMTP Client sample
+
+## Purpose
+
 To show the basics of sending an email via SMTP
 
-# SMTP
+## SMTP
 
 When an IOT device detects a malfunction, it is good to be able to notify the user. 
 We can do that either by sending them an email or via a service like MQTT. 
@@ -20,4 +23,3 @@ It needs some configuration:
 * the name and email of the person to send the email to
 
 Edit the sample to replace these values and the SSID etc.
-

samples/Wifi_Sniffer/Readme.md → samples/Wifi_Sniffer/README.md

@@ -1,6 +1,12 @@
-# Adaptation of WiFi promiscuous mode demo code from Arduino
+# WiFi Sniffer sample
 
-// See https://www.hackster.io/rayburne/esp8266-mini-sniff-f6b93a
+## Introduction
+
+This is an adaptation of the WiFi promiscuous mode demo code from Arduino
+
+See https://www.hackster.io/rayburne/esp8266-mini-sniff-f6b93a
+
+```
 
 // Notes.h tab in Arduino IDE is only for comments and references!
 
@@ -95,3 +101,4 @@
 
 
 */
+```