Skip to content

Commit 34b88b4

Browse files
committed
fix(README): Fixed links and simplify the usage descritpion
1 parent 3dab3cb commit 34b88b4

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Espressif TinyUSB fork
1+
# Espressif TinyUSB component
22

3-
This is a fork of upstream [TinyUSB](https://github.com/hathach/tinyusb) with integration into ESP-IDF build system.
4-
It is used mostly for rapid bugfixing and for releases independent from the upstream project.
5-
We try to push all bugfixes and features to the upstream.
3+
Upstream [TinyUSB](https://github.com/hathach/tinyusb) fork with integration into ESP-IDF build system.
64

75
## How to use
86

9-
There are two options of using TinyUSB with Espressif's SoCs.
7+
There are two options of using TinyUSB component with Espressif's SoCs:
108

11-
### 1. Use this component together with [Espressif TinyUSB additions](https://github.com/espressif/idf-extra-components/tree/master/usb/esp_tinyusb/)
9+
### 1. Use component via [Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb)
1210

13-
This is identical approach as in ESP-IDF 4.x releases. You can configure TinyUSB using Kconfig, as usual. Just add ``idf_component.yml`` to your main component with the following content::
11+
[Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb) provides several preconfigured features to use benefits of TinyUSB stack faster.
12+
13+
To use [Espressif TinyUSB additions](https://github.com/espressif/esp-usb/tree/master/device/esp_tinyusb), add ``idf_component.yml`` to your main component with the following content::
1414

1515
```yaml
1616
## IDF Component Manager Manifest File
@@ -22,7 +22,10 @@ Or simply run:
2222
```
2323
idf.py add-dependency "esp_tinyusb^1.0.0"
2424
```
25-
### 2. Use TinyUSB only, without the [additions](https://github.com/espressif/idf-extra-components/tree/master/usb/esp_tinyusb/)
25+
26+
Then, the Espressif TinyUSB component will be added automatically during resolving dependencies by the component manager.
27+
28+
### 2. Use component directly
2629

2730
Use this option for custom TinyUSB applications.
2831
In this case you will have to provide configuration header file ``tusb_config.h``. More information about TinyUSB configuration can be found [in official TinyUSB documentation](https://docs.tinyusb.org/en/latest/reference/getting_started.html).

0 commit comments

Comments
 (0)