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 | |
| parent | a5b8a67c80e0eaf75e0c57c6a752551682898f5a (diff) | |
update docs
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/boards.md | 4 | ||||
| -rw-r--r-- | examples/readme.md | 37 |
3 files changed, 40 insertions, 3 deletions
@@ -61,7 +61,7 @@ The stack supports the following MCUs ## Compiler & IDE -The stack is developed with GCC compiler, and should be compilable with others. Folder `examples` provide Makefile and Segger Embedded Studio build support. +The stack is developed with GCC compiler, and should be compilable with others. Folder `examples` provide Makefile and Segger Embedded Studio build support. [Here is instruction to build example](examples/readme.md). ## Getting Started diff --git a/docs/boards.md b/docs/boards.md index 0473ee0e6..b4bd4a12e 100644 --- a/docs/boards.md +++ b/docs/boards.md @@ -17,8 +17,10 @@ This code base already had supported for a handful of following boards ### NXP LPC -- [LPCXpresso 11U68](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc11u68:OM13058) +- [LPCXpresso 11u37](https://www.nxp.com/design/microcontrollers-developer-resources/lpcxpresso-boards/lpcxpresso-board-for-lpc11u37h:OM13074) +- [LPCXpresso 11u68](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc11u68:OM13058) - [LPCXpresso 1347](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1347:OM13045) +- [ARM mbed LPC1768](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/arm-mbed-lpc1768-board:OM11043) - [LPCXpresso 1769](https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1769:OM13000) - [Keil MCB1800 Evaluation Board](http://www.keil.com/mcb1800) - [Embedded Artists LPC4088 Quick Start board](https://www.embeddedartists.com/products/lpc4088-quickstart-board) 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 +``` + |