Merge branch 'feature/category_readme' into 'master'

Readme and links to example category folders

- Added README.md to example category folders, for BT ref. https://github.com/espressif/esp-idf/issues/262
- Added links from api category TOC to example category folders

See merge request !450

docs/api/bluetooth/index.rst

@@ -8,3 +8,5 @@ Bluetooth API
    Bluetooth Common <bt_common>
    Bluetooth LE <bt_le>
 
+
+Example code for this API section is provided in `examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ directory of ESP-IDF repository.

docs/api/ethernet/index.rst

@@ -6,3 +6,5 @@ Ethernet API
 
    Ethernet <esp_eth>
 
+
+Example code for this API section is provided in `examples/ethernet <https://github.com/espressif/esp-idf/tree/master/examples/ethernet>`_ directory of ESP-IDF repository.

docs/api/peripherals/index.rst

@@ -14,3 +14,5 @@ Peripherals API
    LED Control <ledc>
    Remote Control <rmt>
 
+
+Example code for this API section is provided in `examples/peripherals <https://github.com/espressif/esp-idf/tree/master/examples/peripherals>`_ directory of ESP-IDF repository.

docs/api/protocols/index.rst

@@ -6,3 +6,5 @@ Protocols API
 
    mDNS <mdns>
 
+
+Example code for this API section is provided in `examples/protocols <https://github.com/espressif/esp-idf/tree/master/examples/protocols>`_ directory of ESP-IDF repository.

docs/api/storage/index.rst

@@ -10,3 +10,5 @@ Storage API
    Virtual Filesystem <vfs>
    FAT Filesystem <fatfs>
 
+
+Example code for this API section is provided in `examples/storage <https://github.com/espressif/esp-idf/tree/master/examples/storage>`_ directory of ESP-IDF repository.

docs/api/system/index.rst

@@ -11,3 +11,5 @@ System API
    Deep Sleep <deep_sleep>
    Logging <log>
 
+
+Example code for this API section is provided in `examples/system <https://github.com/espressif/esp-idf/tree/master/examples/system>`_ directory of ESP-IDF repository.

docs/api/wifi/index.rst

@@ -6,3 +6,6 @@ Wi-Fi API
 
    Wi-Fi <esp_wifi>
    Smart Config <esp_smartconfig>
+
+
+Example code for this API section is provided in `examples/wifi <https://github.com/espressif/esp-idf/tree/master/examples/wifi>`_ directory of ESP-IDF repository.

examples/bluetooth/README.md

@@ -0,0 +1,5 @@
+# Bluetooth Examples
+
+Note: To use examples in this directory, you need to have Bluetooth enabled in configuration. Run `make menuconfig`, go to `Component config` and verify if you see `[*] Bluetooth`. If not - enable it and save.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/ethernet/README.md

@@ -0,0 +1,3 @@
+# Ethernet Examples
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/get-started/README.md

@@ -0,0 +1,5 @@
+# Get Started Examples
+
+Simple code to get started with ESP32 and ESP-IDF.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/peripherals/README.md

@@ -0,0 +1,5 @@
+# Peripherals Examples
+
+This section provides examples how to configure and use ESP32’s internal peripherals like GPIO, UART, I2C, SPI, timers, counters, ADC / DAC, PWM, etc.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/protocols/README.md

@@ -0,0 +1,5 @@
+# Protocols Examples
+
+Implementation of internet communication protocols and services.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/protocols/mdns/README.md

@@ -1,4 +1,4 @@
-# 30_mdns example
+# mDNS example
 
 Shows how to use mDNS to advertise lookup services and hosts
 

examples/storage/README.md

@@ -0,0 +1,5 @@
+# Storage Examples
+
+Storage and management of user and system data in module’s flash and on external memory / devices.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/system/README.md

@@ -0,0 +1,5 @@
+# System Examples
+
+Configuration and management of memory, interrupts, WDT (watchdog timer), OTA (over the air updates), deep sleep and logging.
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.

examples/wifi/README.md

@@ -0,0 +1,3 @@
+# Wi-Fi Examples
+
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.