README

painlessMesh Documentation

Welcome to the comprehensive documentation for painlessMesh - a user-friendly ESP8266/ESP32 mesh networking library that automatically handles routing and network management.

Documentation Structure

Getting Started

• Quick Start Guide - Get up and running in minutes
• Installation - Detailed installation instructions
• First Mesh Network - Your first working mesh

Architecture & Design

• Mesh Architecture - How painlessMesh works internally
• Plugin System - Understanding the plugin architecture

API Reference

• Core API - Main painlessMesh class methods
• Plugin System - Creating custom packages and plugins
• Configuration - Configuration options and constants
• Callbacks - Event handling and callbacks

Tutorials & Examples

• Basic Examples - Simple mesh networking examples
• Alteriom Packages - Type-safe message packages and creating your own
• Bridge to Internet - Connecting mesh to external networks

Alteriom Extensions

• Alteriom Overview - Alteriom-specific functionality

Troubleshooting

• Common Issues - Solutions to frequent problems
• FAQ - Frequently asked questions

Development

• Contributing - How to contribute to painlessMesh
• Release Process - Understanding releases and versioning

Quick Links

• GitHub Repository
• API Documentation
• Community Forum
• Issue Tracker

Need Help?

• Start with the Quick Start Guide
• Check the FAQ for common questions
• Browse Examples for practical use cases
• Join our Community Forum
• Report bugs on the Issue Tracker

---

This documentation is maintained by the painlessMesh community. Contributions are welcome! See our Contributing Guide to get started.