]> granicus.if.org Git - esp-idf/commitdiff
Added README.md to example category folders
authorkrzychb <krzychb@gazeta.pl>
Wed, 18 Jan 2017 20:03:15 +0000 (21:03 +0100)
committerkrzychb <krzychb@gazeta.pl>
Wed, 18 Jan 2017 20:03:15 +0000 (21:03 +0100)
examples/bluetooth/README.md [new file with mode: 0644]
examples/ethernet/README.md [new file with mode: 0644]
examples/get-started/README.md [new file with mode: 0644]
examples/peripherals/README.md [new file with mode: 0644]
examples/protocols/README.md [new file with mode: 0644]
examples/protocols/mdns/README.md
examples/storage/README.md [new file with mode: 0644]
examples/system/README.md [new file with mode: 0644]
examples/wifi/README.md [new file with mode: 0644]

diff --git a/examples/bluetooth/README.md b/examples/bluetooth/README.md
new file mode 100644 (file)
index 0000000..07bbe8a
--- /dev/null
@@ -0,0 +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
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/ethernet/README.md b/examples/ethernet/README.md
new file mode 100644 (file)
index 0000000..1b9ee84
--- /dev/null
@@ -0,0 +1,3 @@
+# Ethernet Examples\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/get-started/README.md b/examples/get-started/README.md
new file mode 100644 (file)
index 0000000..8a6792e
--- /dev/null
@@ -0,0 +1,5 @@
+# Get Started Examples\r
+\r
+Simple code to get started with ESP32 and ESP-IDF.\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/peripherals/README.md b/examples/peripherals/README.md
new file mode 100644 (file)
index 0000000..fdb4444
--- /dev/null
@@ -0,0 +1,5 @@
+# Peripherals Examples\r
+\r
+This section provides examples how to configure and use ESP32’s internal peripherals like GPIO, UART, I2C, SPI, timers, counters, ADC / DAC, PWM, etc.\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/protocols/README.md b/examples/protocols/README.md
new file mode 100644 (file)
index 0000000..2c34c3d
--- /dev/null
@@ -0,0 +1,5 @@
+# Protocols Examples\r
+\r
+Implementation of internet communication protocols and services.\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
index 1c298604b8823b26f9701b76ce895d2ffa932c44..76dbdc17b7f4f3254ee7232ec9a713a0a061e62a 100644 (file)
@@ -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 (file)
index 0000000..36b1f64
--- /dev/null
@@ -0,0 +1,5 @@
+# Storage Examples\r
+\r
+Storage and management of user and system data in module’s flash and on external memory / devices.\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/system/README.md b/examples/system/README.md
new file mode 100644 (file)
index 0000000..3fb812f
--- /dev/null
@@ -0,0 +1,5 @@
+# System Examples\r
+\r
+Configuration and management of memory, interrupts, WDT (watchdog timer), OTA (over the air updates), deep sleep and logging.\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r
diff --git a/examples/wifi/README.md b/examples/wifi/README.md
new file mode 100644 (file)
index 0000000..b0dc683
--- /dev/null
@@ -0,0 +1,3 @@
+# Wi-Fi Examples\r
+\r
+See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.\r