]> granicus.if.org Git - esp-idf/commitdiff
Added links from api category TOC to example category folders
authorkrzychb <krzychb@gazeta.pl>
Wed, 18 Jan 2017 20:04:11 +0000 (21:04 +0100)
committerkrzychb <krzychb@gazeta.pl>
Wed, 18 Jan 2017 20:21:02 +0000 (21:21 +0100)
Typo fix in bluetooth README.md

docs/api/bluetooth/index.rst
docs/api/ethernet/index.rst
docs/api/peripherals/index.rst
docs/api/protocols/index.rst
docs/api/storage/index.rst
docs/api/system/index.rst
docs/api/wifi/index.rst
examples/bluetooth/README.md

index fffe6744255716ee9f42c843f3971b503159b1ea..5a096c75efa4ffd5349698b6ea087f07318b4796 100644 (file)
@@ -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.
index aeb0137c5ed91c5eccdc93ec9da9052e1b960ab6..31181d23ea55ea4ceba72d57758a9f8b5f76deb2 100644 (file)
@@ -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.
index 9ea0c41ab621455b77b181ff5402adad69d1a1e5..147a722fc6625de8220d40607b890b10efed0f41 100644 (file)
@@ -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.
index 632bd141dcb7995ae6718fd9668587d8f52766fd..9a3a9a0c2fa0c4ff5fe335e5e61025a4c556f609 100644 (file)
@@ -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.
index 30fb2088c759153d601102403166597e008f932a..bf21cc9eea03f9448dc5a31cef83e9e70a526a6c 100644 (file)
@@ -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.
index 6bbd7c10c5436dadcd56c3aef590f4b00b5114f0..f5746f80fd06ae011ad8ae520fe65b36b2392e9b 100644 (file)
@@ -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.
index 2abe2b2fff8c0750470bceda301f3e18f435d3e5..aecf87fa3b515f577f46e52123f77ed5dcf547bf 100644 (file)
@@ -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.
index 07bbe8ac146538af413a70762bca310ec4aae403..3d60a5916232711939aab82ba460a766072c1e0b 100644 (file)
@@ -1,5 +1,5 @@
 # Bluetooth Examples\r
 \r
-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 if and save.\r
+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.\r
 \r
 See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r