Skip to content

Commit d9d3771

Browse files
authored
Merge pull request #501 from gabsuren/update_examples
docs(common): Enhance documentation clarity in the examples directory
2 parents 5ba7cfa + 110536e commit d9d3771

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

examples/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Examples
2+
3+
## Overview
4+
5+
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.
6+
7+
## Detailed Examples
8+
9+
1. **Multiple Network Interfaces Example**: Demonstrates the integration and management of multiple network interfaces.
10+
Location: [multiple_netifs](esp_netif/multiple_netifs)
11+
12+
2. **SLIP Device Client**: Provides a detailed example of a SLIP (Serial Line Internet Protocol) device client implementation.
13+
Location: [slip_custom_netif](esp_netif/slip_custom_netif/)
14+
15+
3. **MQTT Demo on Linux**: A comprehensive demonstration of an MQTT (Message Queuing Telemetry Transport) application designed to run on a Linux environment.
16+
Location: [mqtt](mqtt)
17+
18+
## Additional Resources and Examples
19+
20+
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.
21+
22+
**Important**: To explore more, check the path: `components/*component_name/examples`

0 commit comments

Comments
 (0)