update doc

This commit is contained in:
hathach
2014-04-15 00:10:01 +07:00
parent beb46a2492
commit 622704a196
3 changed files with 70 additions and 33 deletions

View File

@@ -5,13 +5,11 @@
**Table of Contents**
- [Download](#download)
- [Import and Build](#import-and-build)
- [Prerequisites](#prerequisites)
- [Configure demo](#configure-demo)
- [Add tinyusb to your project](#add-tinyusb-to-your-project)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Download ##
## Download
tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project.
@@ -21,22 +19,28 @@ After downloading/cloning, the code base is composed of
Folder | Description
----- | -------------
*boards* | Source files of supported boards
*demos* | Source & project files for demonstration application
*mcu* | Low level mcu core & peripheral drivers (e.g CMSIS )
*tests* | Unit tests for the stack
*tinyusb* | All sources files for tinyusb stack itself.
*vendor* | Source files from 3rd party such as freeRTOS, fatfs etc ...
boards | Source files of supported boards
demos | Source & project files for demonstration application
mcu | Low level mcu core & peripheral drivers (e.g CMSIS )
tests | Unit tests for the stack
tinyusb | All sources files for tinyusb stack itself.
vendor | Source files from 3rd party such as freeRTOS, fatfs etc ...
*repo/demos* is the folder where all the application & project files are located. There are demos for both device and hosts. For each, there are different projects for each of supported RTOS.
## Prerequisites ##
## Add tinyusb to your project
It is relatively simple to incorporate tinyusb to your (existing) project
1. Copy core folder /**tinyusb** to your project. Let's say it is *your_project/tinyusb*
2. Add all the .c in the core folder to your project settings (uvproj, ewp, makefile)
3. Add *your_project/tinysb* to your include path. Also make sure your current include path also contains the configuration file tusb_config.h. Or you could simply put the tusb_config.h into the tinyusb folder as well.
4. Make sure all required macros such as TUSB_CFG_MCU are all defined properly in tusb_config.h.
In order to build and run application demo, you would need
- A [supported development board](../../boards/readme.md)
- A supported toolchain: LPCXpresso, Keil, IAR.
\subpage md_boards_readme
\subpage md_doxygen_started_build_demo
\subpage md_doxygen_started_run_demo