Added README.md to example category folders

adrianM27 · Jan 18, 2017 · 0b6598c · 0b6598c
1 parent 30c2fca
commit 0b6598c
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 1 deletion.
diff --git a/examples/bluetooth/README.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Ethernet Examples

		See the [README.md](../README.md) file in the upper level [examples](../) directory for more information about examples.
Original file line number	Diff line number	Diff line change
		@@ -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.