diff options
| author | hathach <[email protected]> | 2019-09-06 16:50:00 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2019-09-06 16:50:00 +0700 |
| commit | f5bb48fed50662e8c83610c03030277a1a5a546b (patch) | |
| tree | d14f73597f2ca4124a63d0b3f8ef4c0e605e2d47 /examples | |
| parent | a5b8a67c80e0eaf75e0c57c6a752551682898f5a (diff) | |
update docs
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/readme.md | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/examples/readme.md b/examples/readme.md index 228029e99..f48e897d6 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -1,3 +1,38 @@ # Examples -Build and Run example instructions
\ No newline at end of file +## Clone this repo + +``` +$ git clone https://github.com/hathach/tinyusb tinyusb +$ cd tinyusb +``` + +## Fetch submodule MCUs drivers + +TinyUSB examples includes external repos aka submodules to provide low-level MCU peripheral's driver to compile with. Therefore we will firstly fetch those mcu driver repo by running this command in the top folder repo + +``` +$ git submodule update --init --rescursive +``` + +It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once. + +## 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 + +``` +$ cd examples/device/cdc_msc_hid +$ make BOARD=feather_nrf52840_express all +``` + +## Flash + +TODO: write more on flashing + +``` +$ make BOARD=feather_nrf52840_express flash +``` + |
