summaryrefslogtreecommitdiff
path: root/doxygen/getting_started.md
diff options
context:
space:
mode:
authorhathach <[email protected]>2014-04-11 12:09:49 +0700
committerhathach <[email protected]>2014-04-11 12:09:49 +0700
commit7a8003adfbba3f3f21942a42d896333f1be7435e (patch)
treefa581947f40f287ceaff8699fa6aadff10baee19 /doxygen/getting_started.md
parent76f875d7823c388850f25350a62d49653c7030bb (diff)
rename getting_started.md
Diffstat (limited to 'doxygen/getting_started.md')
-rw-r--r--doxygen/getting_started.md41
1 files changed, 41 insertions, 0 deletions
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 #
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [Download](#download)
+- [Import and Build](#import-and-build)
+ - [Prerequisites](#prerequisites)
+- [Configure demo](#configure-demo)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## 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