Skip to content

Commit

Permalink
docs index.rst pointed to README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
hathach committed Dec 27, 2024
1 parent 824793a commit 29f226c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 31 deletions.
27 changes: 3 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ Sponsors

TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project.

.. figure:: docs/assets/adafruit_logo.svg
.. figure:: /docs/assets/adafruit_logo.svg
:alt: Adafruit Logo
:target: https://www.adafruit.com

TinyUSB Project
===============

.. figure:: docs/assets/logo.svg
.. figure:: /docs/assets/logo.svg
:alt: TinyUSB

TinyUSB is an open-source cross-platform USB Host/Device stack for
embedded system, designed to be memory-safe with no dynamic allocation
and thread-safe with all interrupt events are deferred then handled in
the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.

.. figure:: docs/assets/stack.svg
.. figure:: /docs/assets/stack.svg
:width: 500px
:alt: stackup

Expand Down Expand Up @@ -250,27 +250,6 @@ individually licensed especially those in ``lib`` and ``hw/mcu`` folder.
Please make sure you understand all the license term for files you use
in your project.

Docs
====

- Info

- `Uses`_
- `Changelog`_
- `Contributors`_

- `Reference`_

- `Getting Started`_
- `Supported Boards`_
- `Dependencies`_
- `Concurrency`_

- `Contributing`_

- `Code of Conduct`_
- `Structure`_
- `Porting`_

.. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/build.yml/badge.svg
:target: https://github.com/hathach/tinyusb/actions
Expand Down
8 changes: 1 addition & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
:hide-toc:

*********
TinyUSB
*********

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 being deferred and then handled in the non-ISR task function.

.. include:: ../README.rst

.. toctree::
:caption: Index
Expand Down

0 comments on commit 29f226c

Please sign in to comment.