kingkevin
/
esp32-s2_dfu
1
0
Fork 0
Code Issues Releases Activity

update docs

This commit is contained in:
hathach 2019-09-06 16:50:00 +07:00
parent a5b8a67c80
commit f5bb48fed5
3 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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

4
docs/boards.md
View File

@ -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)

37
examples/readme.md
View File

@ -1,3 +1,38 @@
# Examples
Build and Run example instructions
## 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
```