diff options
| author | hathach <[email protected]> | 2023-03-23 16:33:35 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2023-03-23 16:33:35 +0700 |
| commit | f80d11301ea03746d86dd64c651b31bd600772f7 (patch) | |
| tree | 130f6ffc6ea1fe3678ee024bab1e9987b47dea46 /docs/reference/getting_started.rst | |
| parent | cd0fdc32644f21a4946563c065c9bddfa32d60ee (diff) | |
update doc and generate deps list
Diffstat (limited to 'docs/reference/getting_started.rst')
| -rw-r--r-- | docs/reference/getting_started.rst | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/docs/reference/getting_started.rst b/docs/reference/getting_started.rst index ef4a6ba61..1f41cb888 100644 --- a/docs/reference/getting_started.rst +++ b/docs/reference/getting_started.rst @@ -44,12 +44,6 @@ For your convenience, TinyUSB contains a handful of examples for both host and d $ git clone https://github.com/hathach/tinyusb tinyusb $ cd tinyusb -Some TinyUSB examples also requires external submodule libraries in ``/lib`` such as FreeRTOS, Lightweight IP to build. Run following command to fetch them - -.. code-block:: - - $ git submodule update --init lib - Some ports will also require a port-specific SDK (e.g. RP2040) or binary (e.g. Sony Spresense) to build examples. They are out of scope for tinyusb, you should download/install it first according to its manufacturer guide. Build @@ -61,23 +55,25 @@ To build example, first change directory to an example folder. $ cd examples/device/cdc_msc -Before building, we need to download MCU driver submodule to provide low-level MCU peripheral's driver first. Run the ``get-deps`` target in one of the example folder as follow. You only need to do this once per mcu +Before building, we firstly need to download dependencies such as: MCU low-level peripheral driver and external libraries e.g FreeRTOS (required by some examples). Run the ``get-deps`` target in one of the example folder as follow. You only need to do this once per mcu. Check out `complete list of dependencies and their designated path here <dependencies.rst>`_ .. code-block:: - $ make BOARD=feather_nrf52840_express get-deps - - -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. + $ make BOARD=raspberry_pi_pico get-deps Then compile with ``make BOARD=[board_name] all``\ , for example .. code-block:: - $ make BOARD=feather_nrf52840_express all + $ make BOARD=raspberry_pi_pico all Note: ``BOARD`` can be found as directory name in ``hw/bsp``\ , either in its family/boards or directly under bsp (no family). -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. +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 ``99-tinyusb.rules`` and reload your udev is good to go + +.. code-block:: + + $ cp examples/device/99-tinyusb.rules /etc/udev/rules.d/ + $ sudo udevadm control --reload-rules && sudo udevadm trigger Port Selection ~~~~~~~~~~~~~~ |
