diff options
| author | hathach <[email protected]> | 2025-11-11 10:27:47 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2025-11-11 10:53:39 +0700 |
| commit | a1ae5b20ccf760282538dd81b9290527757fa9c7 (patch) | |
| tree | a533fccebf77b046bbd6002f9bb077d98a9df6c3 /docs/index.rst | |
| parent | 6364a4df7a6e3a2b3583fe11a88665f06d18628b (diff) | |
update doc
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 37 |
1 files changed, 4 insertions, 33 deletions
diff --git a/docs/index.rst b/docs/index.rst index ac10dbfd7..39d30a038 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,45 +1,21 @@ -TinyUSB Documentation -===================== - -TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems, designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events deferred to non-ISR task functions. - -For Developers --------------- - -TinyUSB provides a complete USB stack implementation supporting both device and host modes across a wide range of microcontrollers. The stack is designed for resource-constrained embedded systems with emphasis on code size, memory efficiency, and real-time performance. - -**Key Features:** - -* **Thread-safe design**: All USB interrupts are deferred to task context -* **Memory-safe**: No dynamic allocation, all buffers are statically allocated -* **Portable**: Supports 30+ MCU families from major vendors -* **Comprehensive**: Device classes (CDC, HID, MSC, Audio, etc.) and Host stack -* **RTOS support**: Works with bare metal, FreeRTOS, RT-Thread, and Mynewt - -**Quick Navigation:** - -* New to TinyUSB? Start with :doc:`getting_started` and :doc:`reference/glossary` -* Want to understand the design? Read :doc:`reference/architecture` and :doc:`reference/usb_concepts` -* Having issues? Check :doc:`faq` and :doc:`troubleshooting` - -Documentation Structure ------------------------ +.. include:: ../README_processed.rst .. toctree:: :maxdepth: 2 :caption: Information getting_started + integration + porting + reference/index faq troubleshooting - reference/index .. toctree:: :maxdepth: 1 :caption: Project Info info/index - contributing/index .. toctree:: :caption: External Links @@ -48,8 +24,3 @@ Documentation Structure Source Code <https://github.com/hathach/tinyusb> Issue Tracker <https://github.com/hathach/tinyusb/issues> Discussions <https://github.com/hathach/tinyusb/discussions> - -GitHub Project Main README -========================== - -.. include:: ../README_processed.rst |