From 110536ebb2af32da4bd1c7826112417f1b9d64d1 Mon Sep 17 00:00:00 2001 From: Suren Gabrielyan <suren.gabrielyan@espressif.com> Date: Wed, 31 Jan 2024 12:34:21 +0400 Subject: [PATCH] docs(common): Enhance documentation clarity in the examples directory --- examples/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000000..6e198bb2e6 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,22 @@ +# Examples + +## Overview + +This directory showcases a variety of examples, illustrating the use of different interfaces and functionalities. Navigate through these examples to understand how to implement and integrate various components and features in your projects. + +## Detailed Examples + +1. **Multiple Network Interfaces Example**: Demonstrates the integration and management of multiple network interfaces. + Location: [multiple_netifs](esp_netif/multiple_netifs) + +2. **SLIP Device Client**: Provides a detailed example of a SLIP (Serial Line Internet Protocol) device client implementation. + Location: [slip_custom_netif](esp_netif/slip_custom_netif/) + +3. **MQTT Demo on Linux**: A comprehensive demonstration of an MQTT (Message Queuing Telemetry Transport) application designed to run on a Linux environment. + Location: [mqtt](mqtt) + +## Additional Resources and Examples + +For an extensive collection of additional examples, especially those related to specific components, please visit the upper layer directory and navigate to the respective component's example directory. + +**Important**: To explore more, check the path: `components/*component_name/examples`