Skip to content

Commit a80f237

Browse files
authored
Some platforms require SDKs and use of cmake
1 parent a592282 commit a80f237

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/reference/getting_started.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Some TinyUSB examples also requires external submodule libraries in ``/lib`` suc
5252
5353
In addition, MCU driver submodule is also needed to provide low-level MCU peripheral's driver. Luckily, it will be fetched if needed when you run the ``make`` to build your board.
5454

55+
Some modules will also require a module-specific SDK (e.g. RP2040) or binary (e.g. Sony Spresense) to build examples.
56+
5557
Note: some examples especially those that uses Vendor class (e.g webUSB) may requires udev permission on Linux (and/or macOS) to access usb device. It depends on your OS distro, typically copy ``/examples/device/99-tinyusb.rules`` file to /etc/udev/rules.d/ then run ``sudo udevadm control --reload-rules && sudo udevadm trigger`` is good enough.
5658

5759
Build
@@ -63,6 +65,8 @@ To build example, first change directory to an example folder.
6365
6466
$ cd examples/device/cdc_msc
6567
68+
Some modules (e.g. RP2040 and ESP32s2) require the project makefiles to be customized using CMake. If necessary apply any setup steps for the platform's SDK.
69+
6670
Then compile with ``make BOARD=[board_name] all``\ , for example
6771

6872
.. code-block::

0 commit comments

Comments
 (0)