summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2014-03-28 17:50:30 +0700
committerhathach <[email protected]>2014-03-28 17:50:30 +0700
commitd70decf27f5cd7c78c852e15942b6764b7fd36d0 (patch)
tree6553135cd50cc3aba9019686200720878a4b6ad6
parentf7403d0b52083a84cbc8e3f1a8e15a00c3ca1471 (diff)
update md
-rw-r--r--readme.markdown18
-rw-r--r--tests/readme.md2
2 files changed, 19 insertions, 1 deletions
diff --git a/readme.markdown b/readme.markdown
index e81634ba7..4c44feea4 100644
--- a/readme.markdown
+++ b/readme.markdown
@@ -1,5 +1,23 @@
# tinyusb #
+<!-- 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**
+
+- [Features](#features)
+ - [Host](#host)
+ - [Device](#device)
+ - [RTOS](#rtos)
+ - [Supported MCUs](#supported-mcus)
+ - [Toolchains](#toolchains)
+- [Getting Started](#getting-started)
+- [License](#license)
+- [How Can I Help](#how-can-i-help)
+ - [Donate Time](#donate-time)
+ - [Donate Money](#donate-money)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controllers, especially ARM MCUs. It is designed to be user-friendly in term of configuration and out-of-the-box running experience.
In addition to running without an RTOS, tinyusb is an OS-awared stack that can run across RTOS vendors. For the purpose of eliminating bugs as soon as possible, the stack is developed using [Test-Driven Development (TDD)](tests/readme.md) approach
diff --git a/tests/readme.md b/tests/readme.md
index 3fef9afd0..9e891c13d 100644
--- a/tests/readme.md
+++ b/tests/readme.md
@@ -15,4 +15,4 @@ Continuous Integration (CI) is used to automatically run all the tests whenever
As many other open source project, tinyusb uses Travis-CI server (free for OOS). You can find my project on Travis here https://travis-ci.org/hathach/tinyusb
-![Build Status](https://travis-ci.org/hathach/tinyusb.svg?branch=master)
+![Build Status](https://travis-ci.org/hathach/tinyusb.svg?branch=master) \ No newline at end of file