From 0b6598c49206228896f41f20ada2382270d9da6b Mon Sep 17 00:00:00 2001 From: krzychb Date: Wed, 18 Jan 2017 21:03:15 +0100 Subject: [PATCH 1/2] Added README.md to example category folders --- examples/bluetooth/README.md | 5 +++++ examples/ethernet/README.md | 3 +++ examples/get-started/README.md | 5 +++++ examples/peripherals/README.md | 5 +++++ examples/protocols/README.md | 5 +++++ examples/protocols/mdns/README.md | 2 +- examples/storage/README.md | 5 +++++ examples/system/README.md | 5 +++++ examples/wifi/README.md | 3 +++ 9 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 examples/bluetooth/README.md create mode 100644 examples/ethernet/README.md create mode 100644 examples/get-started/README.md create mode 100644 examples/peripherals/README.md create mode 100644 examples/protocols/README.md create mode 100644 examples/storage/README.md create mode 100644 examples/system/README.md create mode 100644 examples/wifi/README.md diff --git a/examples/bluetooth/README.md b/examples/bluetooth/README.md new file mode 100644 index 0000000000..07bbe8ac14 --- /dev/null +++ b/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 if and save. + +See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples. diff --git a/examples/ethernet/README.md b/examples/ethernet/README.md new file mode 100644 index 0000000000..1b9ee845bb --- /dev/null +++ b/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. diff --git a/examples/get-started/README.md b/examples/get-started/README.md new file mode 100644 index 0000000000..8a6792e718 --- /dev/null +++ b/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. diff --git a/examples/peripherals/README.md b/examples/peripherals/README.md new file mode 100644 index 0000000000..fdb4444191 --- /dev/null +++ b/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. diff --git a/examples/protocols/README.md b/examples/protocols/README.md new file mode 100644 index 0000000000..2c34c3da60 --- /dev/null +++ b/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. diff --git a/examples/protocols/mdns/README.md b/examples/protocols/mdns/README.md index 1c298604b8..76dbdc17b7 100644 --- a/examples/protocols/mdns/README.md +++ b/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 diff --git a/examples/storage/README.md b/examples/storage/README.md new file mode 100644 index 0000000000..36b1f64b27 --- /dev/null +++ b/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. diff --git a/examples/system/README.md b/examples/system/README.md new file mode 100644 index 0000000000..3fb812f307 --- /dev/null +++ b/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. diff --git a/examples/wifi/README.md b/examples/wifi/README.md new file mode 100644 index 0000000000..b0dc683508 --- /dev/null +++ b/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. From 16b23a407cde7492c215c4019ddaef9200412a72 Mon Sep 17 00:00:00 2001 From: krzychb Date: Wed, 18 Jan 2017 21:04:11 +0100 Subject: [PATCH 2/2] Added links from api category TOC to example category folders Typo fix in bluetooth README.md --- docs/api/bluetooth/index.rst | 2 ++ docs/api/ethernet/index.rst | 2 ++ docs/api/peripherals/index.rst | 2 ++ docs/api/protocols/index.rst | 2 ++ docs/api/storage/index.rst | 2 ++ docs/api/system/index.rst | 2 ++ docs/api/wifi/index.rst | 3 +++ examples/bluetooth/README.md | 2 +- 8 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/api/bluetooth/index.rst b/docs/api/bluetooth/index.rst index fffe674425..5a096c75ef 100644 --- a/docs/api/bluetooth/index.rst +++ b/docs/api/bluetooth/index.rst @@ -8,3 +8,5 @@ Bluetooth API Bluetooth Common Bluetooth LE + +Example code for this API section is provided in `examples/bluetooth `_ directory of ESP-IDF repository. diff --git a/docs/api/ethernet/index.rst b/docs/api/ethernet/index.rst index aeb0137c5e..31181d23ea 100644 --- a/docs/api/ethernet/index.rst +++ b/docs/api/ethernet/index.rst @@ -6,3 +6,5 @@ Ethernet API Ethernet + +Example code for this API section is provided in `examples/ethernet `_ directory of ESP-IDF repository. diff --git a/docs/api/peripherals/index.rst b/docs/api/peripherals/index.rst index 9ea0c41ab6..147a722fc6 100644 --- a/docs/api/peripherals/index.rst +++ b/docs/api/peripherals/index.rst @@ -14,3 +14,5 @@ Peripherals API LED Control Remote Control + +Example code for this API section is provided in `examples/peripherals `_ directory of ESP-IDF repository. diff --git a/docs/api/protocols/index.rst b/docs/api/protocols/index.rst index 632bd141dc..9a3a9a0c2f 100644 --- a/docs/api/protocols/index.rst +++ b/docs/api/protocols/index.rst @@ -6,3 +6,5 @@ Protocols API mDNS + +Example code for this API section is provided in `examples/protocols `_ directory of ESP-IDF repository. diff --git a/docs/api/storage/index.rst b/docs/api/storage/index.rst index 30fb2088c7..bf21cc9eea 100644 --- a/docs/api/storage/index.rst +++ b/docs/api/storage/index.rst @@ -10,3 +10,5 @@ Storage API Virtual Filesystem FAT Filesystem + +Example code for this API section is provided in `examples/storage `_ directory of ESP-IDF repository. diff --git a/docs/api/system/index.rst b/docs/api/system/index.rst index 6bbd7c10c5..f5746f80fd 100644 --- a/docs/api/system/index.rst +++ b/docs/api/system/index.rst @@ -11,3 +11,5 @@ System API Deep Sleep Logging + +Example code for this API section is provided in `examples/system `_ directory of ESP-IDF repository. diff --git a/docs/api/wifi/index.rst b/docs/api/wifi/index.rst index 2abe2b2fff..aecf87fa3b 100644 --- a/docs/api/wifi/index.rst +++ b/docs/api/wifi/index.rst @@ -6,3 +6,6 @@ Wi-Fi API Wi-Fi Smart Config + + +Example code for this API section is provided in `examples/wifi `_ directory of ESP-IDF repository. diff --git a/examples/bluetooth/README.md b/examples/bluetooth/README.md index 07bbe8ac14..3d60a59162 100644 --- a/examples/bluetooth/README.md +++ b/examples/bluetooth/README.md @@ -1,5 +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 if and save. +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.