diff options
| author | Ha Thach <[email protected]> | 2020-04-11 15:49:34 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-04-11 15:49:34 +0700 |
| commit | 04a06ec40147f1f44cfee0567667cc97bbe900ee (patch) | |
| tree | e1efa890fa3ceb93e15244ba6e6df3e61c701910 /examples/readme.md | |
| parent | 4748b349a2812fb2e08f7dfd04866afd50acb98f (diff) | |
| parent | 13a3081d308828ae6e4b9a40bb8ac7bf5b0e424c (diff) | |
Merge branch 'master' into refactor-irqhandler
Diffstat (limited to 'examples/readme.md')
| -rw-r--r-- | examples/readme.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/examples/readme.md b/examples/readme.md index 897931b0e..b661d169f 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -15,22 +15,26 @@ TinyUSB examples includes external repos aka submodules to provide low-level MCU $ git submodule update --init --recursive ``` -It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once. +It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once. Or if you only want to test with a specific mcu, you could only update its driver submodule ## Build -[Here is the list of supported Boards](docs/boards.md) that should work out of the box with provided examples. - -To build example, go to its folder project then type `make BOARD=[our_board] all` e.g +[Here is the list of supported Boards](docs/boards.md) that should work out of the box with provided examples (hopefully). +To build example, first change directory to example folder. + +``` +$ cd examples/device/cdc_msc +``` + +Then compile with `make BOARD=[your_board] all`, for example ``` -$ cd examples/device/cdc_msc_hid $ make BOARD=feather_nrf52840_express all ``` ## Flash -`flash` target will use the on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary. We should install those debugger/programmer software in advance. Futhermore, since external jlink can be used with most of the board, there is also `flash-jlink` target for out convenience. +`flash` target will use the on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary. We should install those debugger/programmer software in advance. Furthermore, since external jlink can be used with most of the board, there is also `flash-jlink` target for your convenience. ``` $ make BOARD=feather_nrf52840_express flash |