Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(common): Enhance documentation clarity in the examples directory #501

Merged
merged 1 commit into from
Feb 5, 2024
Merged

docs(common): Enhance documentation clarity in the examples directory #501

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Loading