yemai/CherryUSB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update doc with Sphinx

Browse Source
This commit is contained in:
sakumisu
2022-02-14 22:39:17 +08:00
parent 0825cbc68a
commit 96f82d5ec8
187 changed files with 26952 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -105,16 +105,12 @@ CherryUSB Host Stack has the following functions：
The CherryUSB Host stack also provides the lsusb function, which allows you to view information about all mounted devices, including those on external hubs, with the help of a shell plugin.
![lsusb](docs/img/lsusb.png)
![lsusb](docs/lsusb.png)
## CherryUSB Device API
## CherryUSB Documentation Tutorial
More of USB Device API reference, please visit : [CherryUSB Device API](docs/usb_device.md)
Quickly start, API manual,and Class knowledge and examples, see [CherryUSB Documentation Tutorial](https://htmlpreview.github.io/?https://raw.githubusercontent.com/sakumisu/CherryUSB/master/docs/_build/html/index.html)
## CherryUSB Host API
## CherryUSB Video Tutorial
More of USB Host API reference, please visit: [CherryUSB Host API](docs/usb_host.md)
## How To Use In RT-Thread package
How to use in RT-Thread package, please visit：[RT-Thread package Userguide with CherryUSB](docs/rt-thread.md)
USB basic concepts and how the CherryUSB Device protocol stack is implemented, see [CherryUSB Device Protocol Stack Tutorial](https://www.bilibili.com/video/BV1Ef4y1t73d).