diff options
| author | Scott Shawcroft <[email protected]> | 2022-02-22 15:03:59 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-02-22 15:03:59 -0800 |
| commit | 8a6fe8a8f398f460d0f2c3575c529e9b4d1b9785 (patch) | |
| tree | 1d84e1683666d685a70f6b77f9beb2cb9cca94c0 | |
| parent | e04f15ff3d1a64991f29da837fb5b3b169fc0bb5 (diff) | |
| parent | a80f23711eefb8d59f76bc70183705d7c368de64 (diff) | |
Merge pull request #1300 from sharpie7/master
Some platforms require SDKs and use of cmake
| -rw-r--r-- | docs/reference/getting_started.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/reference/getting_started.rst b/docs/reference/getting_started.rst index 4a53626cd..fa5c51eff 100644 --- a/docs/reference/getting_started.rst +++ b/docs/reference/getting_started.rst @@ -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 @@ -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:: |