From 0b6598c49206228896f41f20ada2382270d9da6b Mon Sep 17 00:00:00 2001 From: krzychb Date: Wed, 18 Jan 2017 21:03:15 +0100 Subject: [PATCH] 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 000000000..07bbe8ac1 --- /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 000000000..1b9ee845b --- /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 000000000..8a6792e71 --- /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 000000000..fdb444419 --- /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 000000000..2c34c3da6 --- /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 1c298604b..76dbdc17b 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 000000000..36b1f64b2 --- /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 000000000..3fb812f30 --- /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 000000000..b0dc68350 --- /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.