readme: add local links to documentation
.. figure:: docs/assets/logo.svg
:alt: TinyUSB
- TinyUSB
-
|Build Status| |Documentation Status| |License|
TinyUSB is an open-source cross-platform USB Host/Device stack for
@@ -12,13 +10,26 @@ the non-ISR task function.
Please take a look at the online `documentation <www.tinyusb.org>`__.
-Contributors
-============
+Local Docs
+==========
+
+- Info
+
+ - `Uses`_
+ - `Changelog`_
+ - `Contributors`_
+
+- `Reference`_
+
+ - `Supported Devices`_
+ - `Gettin Started`_
+ - `Concurrency`_
-Special thanks to all the people who spent their precious time and
-effort to help this project so far. Check out the
-`CONTRIBUTORS <CONTRIBUTORS.rst>`__ file for the list of all
-contributors and their awesome work for the stack.
+- `Contributing`_
+
+ - `Code of Conduct`_
+ - `Structure`_
+ - `Porting`_
License
=======
@@ -29,9 +40,23 @@ 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.
+
.. |Build Status| image:: https://github.com/hathach/tinyusb/workflows/Build/badge.svg
:target: https://github.com/hathach/tinyusb/actions
.. |Documentation Status| image:: https://readthedocs.org/projects/tinyusb/badge/?version=latest
:target: https://openinput.readthedocs.io/en/latest/?badge=latest
.. |License| image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
:target: https://opensource.org/licenses/MIT
+
+
+.. _Uses: docs/info/uses.rst
+.. _Changelog: docs/info/changelog.rst
+.. _Contributors: CONTRIBUTORS.rst
+.. _Reference: docs/reference/index.rst
+.. _Supported Devices: docs/reference/supported.rst
+.. _Gettin Started: docs/reference/getting_started.rst
+.. _Concurrency: docs/reference/concurrency.rst
+.. _Contributing: docs/contributing/index.rst
+.. _Code of Conduct: CODE_OF_CONDUCT.rst
+.. _Structure: docs/contributing/structure.rst
+.. _Porting: docs/contributing/porting.rst
