From 7a8003adfbba3f3f21942a42d896333f1be7435e Mon Sep 17 00:00:00 2001 From: hathach Date: Fri, 11 Apr 2014 12:09:49 +0700 Subject: rename getting_started.md --- doxygen/get_started.md | 41 ----------------------------------------- doxygen/getting_started.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 41 deletions(-) delete mode 100644 doxygen/get_started.md create mode 100644 doxygen/getting_started.md diff --git a/doxygen/get_started.md b/doxygen/get_started.md deleted file mode 100644 index a5b2d374d..000000000 --- a/doxygen/get_started.md +++ /dev/null @@ -1,41 +0,0 @@ -# Getting Started # - - - -**Table of Contents** - -- [Download](#download) -- [Import and Build](#import-and-build) - - [Prerequisites](#prerequisites) -- [Configure demo](#configure-demo) - - - -## Download ## - -tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project. - -If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install [git](http://git-scm.com/) and front-end gui such as [tortoisegit](http://code.google.com/p/tortoisegit) to begin with. - -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 ... - -*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 ## - -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 \ No newline at end of file diff --git a/doxygen/getting_started.md b/doxygen/getting_started.md new file mode 100644 index 000000000..a5b2d374d --- /dev/null +++ b/doxygen/getting_started.md @@ -0,0 +1,41 @@ +# Getting Started # + + + +**Table of Contents** + +- [Download](#download) +- [Import and Build](#import-and-build) + - [Prerequisites](#prerequisites) +- [Configure demo](#configure-demo) + + + +## Download ## + +tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project. + +If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install [git](http://git-scm.com/) and front-end gui such as [tortoisegit](http://code.google.com/p/tortoisegit) to begin with. + +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 ... + +*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 ## + +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 \ No newline at end of file -- cgit v1.3.1