Embedded/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-01-31 05:52:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

readme: convert md readme to rst

Browse Source 
Signed-off-by: perigoso <perigoso@riseup.net>
This commit is contained in:
perigoso 2021-07-30 11:17:09 +01:00
parent 83d72cc1d5
commit a6ae310f5f
2 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,16 +0,0 @@
![TinyUSB](docs/assets/logo.svg)
[![Build Status](https://github.com/hathach/tinyusb/workflows/Build/badge.svg)](https://github.com/hathach/tinyusb/actions) [![Documentation Status](https://readthedocs.org/projects/tinyusb/badge/?version=latest)](https://openinput.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
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.
Please head over to the online [documentation](www.tinyusb.org) for more info.
## Contributors
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.
## License
All TinyUSB sources in the `src` folder are licensed under MIT license, [Full license is here](LICENSE). However, each file can be 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.

37
README.rst Normal file
View File

@ -0,0 +1,37 @@
.. 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
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.
Please take a look at the online `documentation <www.tinyusb.org>`__.
Contributors
============
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.
License
=======
All TinyUSB sources in the ``src`` folder are licensed under MIT
license, `Full license is here <LICENSE>`__. However, each file can be
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