Skip to content

Commit

Permalink
Merge pull request #1300 from sharpie7/master
Browse files Browse the repository at this point in the history
Some platforms require SDKs and use of cmake
  • Loading branch information
tannewt authored Feb 22, 2022
2 parents e04f15f + a80f237 commit 8a6fe8a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/reference/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Some TinyUSB examples also requires external submodule libraries in ``/lib`` suc
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.

Some modules will also require a module-specific SDK (e.g. RP2040) or binary (e.g. Sony Spresense) to build examples.

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.

Build
Expand All @@ -63,6 +65,8 @@ To build example, first change directory to an example folder.
$ cd examples/device/cdc_msc
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.

Then compile with ``make BOARD=[board_name] all``\ , for example

.. code-block::
Expand Down

0 comments on commit 8a6fe8a

Please sign in to comment.