tinyusb/doxygen/getting_started.md

Getting Started

Table of Contents

• Download
• Import and Build
  • Prerequisites
• 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 and front-end gui such as 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
• A supported toolchain: LPCXpresso, Keil, IAR.

\subpage md_boards_readme \subpage md_doxygen_started_build_demo \subpage md_doxygen_started_run_demo