Samples: .md -> .rst

docs/source/index.rst

@@ -8,8 +8,10 @@ Welcome to Sming's documentation
 Sming is an Open Source framework for high efficiency WiFi SoC ESP8266
 native development with C++ language.
 
-.. image:: combine.png
-   :target: https://github.com/SmingHub/Sming/wiki/examples
+|samples|_
+
+.. |samples| image:: combine.png
+.. _samples: samples/index.html
 
 
 Summary
@@ -56,6 +58,7 @@ See the :doc:`Quick-start <quick-start/index>` page for your respective operatin
    quick-start/index
    host-emulator
    features
+   samples/index
    libraries/index
    api/index
    information/index

docs/source/samples/index.rst

@@ -0,0 +1,16 @@
+***************
+Sample Projects
+***************
+
+Sming comes with a set of samples to illustrate and test various aspects
+of the framework. Some are related to specific :doc:`/libraries/index`.
+
+List of sample projects
+=======================
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+   :titlesonly:
+
+   /_inc/samples/*/README

samples/Basic_SmartConfig/README.rst

@@ -0,0 +1,23 @@
+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.
+
+Basically your ESP device looks for Access Points (AP). When it finds an
+AP with special signature it tries to extract data like SSID and
+password from it. Meanwhile your smart phone tries to send that
+information.
+
+The example here shows how to use ESP_TOUCH method to do smart
+configuration on the device. It is a C++ conversion of the C code that
+Espressif provides in the SDK examples.
+
+| What you will need also is the code that has to be run on your smart
+  phone. Espressif already released some sample code and you can try:
+| \* Android - https://github.com/EspressifApp/EsptouchForAndroid \* iOS
+  - https://github.com/EspressifApp/EsptouchForIOS

samples/Basic_Ssl/README.rst

@@ -0,0 +1,53 @@
+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. This can be done using the following commands:
+
+.. code:: bash
+
+   cd <path-to-sming>/Sming
+   make clean
+   make ENABLE_SSL=1
+
+Once you have enabled the SSL support in SmingFramework you can go
+forward and compile your application with the same directive. For
+example the Basic_Ssl project should be compiled with
+
+.. code:: bash
+
+   cd <path-to-sming>/samples/Basic_Ssl
+   make clean
+   make ENABLE_SSL=1
+
+Now you can flash your application to your ESP8266 device.
+
+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:
+
+.. code:: bash
+
+   cd <path-to-sming>/Sming
+   make clean
+   make ENABLE_SSL=1 SSL_DEBUG=1
+
+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.
+
+If your device is running on battery this can drain the battery much
+faster. If you do not want the switch from 80 to 160 MHz to happen then
+make sure to recompile SmingFramework with *SSL_SLOW_CONNECT* directive.

samples/Basic_WebSkeletonApp/README.rst

@@ -0,0 +1,25 @@
+Basic Web Skeleton sample
+=========================
+
+Introduction
+------------
+
+Basic application that can be used as a start point for some useful App.
+
+Features:
+
+-  can setup wifi ssid and wifi password for STA (wifi client) mode
+   either from own AP or as connected to some wifi network
+-  demonstrate new way of catching wif-events with WifiEvents class
+-  if preconfigured wifi network is unreachable start AP named TyTherm
+   with hardcoded password (see source)
+-  can enable/disable STA (wifi client) mode
+-  own AP autodisable after successful connection to preconfigured wifi
+   network
+-  form population and sending is done with json+ajax
+-  demonstrate usage of getting raw http request body to be processed as
+   json
+-  demonstrate how to fill html template on client side with more
+   flexible than Smings Templating - JavaScript
+
+App called TyTherm because it is base for TinY TermOmeter :)

samples/Basic_WebSkeletonApp_LTS/README.rst

@@ -0,0 +1,25 @@
+Basic Web Skeleton sample
+=========================
+
+Introduction
+------------
+
+Basic application that can be used as a start point for some useful App.
+
+Features:
+
+-  can setup wifi ssid and wifi password for STA (wifi client) mode
+   either from own AP or as connected to some wifi network
+-  demonstrate new way of catching wif-events with WifiEvents class
+-  if preconfigured wifi network is unreachable start AP named TyTherm
+   with hardcoded password (see source)
+-  can enable/disable STA (wifi client) mode
+-  own AP autodisable after successful connection to preconfigured wifi
+   network
+-  form population and sending is done with json+ajax
+-  demonstrate usage of getting raw http request body to be processed as
+   json
+-  demonstrate how to fill html template on client side with more
+   flexible than Smings Templating - JavaScript
+
+App called TyTherm because it is base for TinY TermOmeter :)