diff options
| author | Ha Thach <[email protected]> | 2021-03-10 11:37:07 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-03-10 11:37:07 +0700 |
| commit | ccb599f84bf26e979e209bfe03307ce582e021af (patch) | |
| tree | 431ca32797b665b5c9a76b2fefa5549caa8d9bb8 /docs | |
| parent | 2adb7e719316b12c53a907153cfa0056db1abd70 (diff) | |
| parent | 4a73b6a21930c71368153fe4197b96f9d100fc4c (diff) | |
Merge pull request #710 from hathach/update-doc
update doc for BOARD name, add note for udev on Linux
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting_started.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md index 870491fe2..8ec0ea748 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -47,6 +47,8 @@ $ git submodule update --init lib 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. +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 To build example, first change directory to an example folder. @@ -61,6 +63,8 @@ Then compile with `make BOARD=[board_name] all`, for example $ make BOARD=feather_nrf52840_express all ``` +Note: `BOARD` can be found as directory name in `hw/bsp`, either in its family/boards or directly under bsp (no family). + #### Port Selection If a board has several ports, one port is chosen by default in the individual board.mk file. Use option `PORT=x` To choose another port. For example to select the HS port of a STM32F746Disco board, use: |