summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2014-04-17 12:02:03 +0700
committerhathach <[email protected]>2014-04-17 12:02:03 +0700
commit13a225f1b5c8f50d4b06f8e78b22df33c5126fb1 (patch)
treeeffa527bec86db0084e4504aef0f05e7990bbf3f
parent730065b93e082e39ddf2a6735008181f0295682f (diff)
doc work, comment out \subpage command in markdown result
-rw-r--r--doxygen/getting_started.md9
-rw-r--r--doxygen/started_demo.md15
-rw-r--r--doxygen/started_host_demo.md2
-rw-r--r--readme.markdown27
4 files changed, 20 insertions, 33 deletions
diff --git a/doxygen/getting_started.md b/doxygen/getting_started.md
index c2ca2d9df..7f17bc847 100644
--- a/doxygen/getting_started.md
+++ b/doxygen/getting_started.md
@@ -56,9 +56,6 @@ int main(void)
}
~~~
-
-\subpage md_boards_readme
-
-\subpage md_doxygen_started_demo
-
-\subpage md_tools_readme \ No newline at end of file
+[//]: # (\subpage md_boards_readme)
+[//]: # (\subpage md_doxygen_started_demo)
+[//]: # (\subpage md_tools_readme) \ No newline at end of file
diff --git a/doxygen/started_demo.md b/doxygen/started_demo.md
index 5e13815ec..431750654 100644
--- a/doxygen/started_demo.md
+++ b/doxygen/started_demo.md
@@ -42,16 +42,7 @@ void led_blinking_task( void * p_task_para )
}
~~~
-## Prerequisites ##
-In order to run application demo, you would need
-
-- A [supported development board](../../boards/readme.md)
-- A supported toolchain: LPCXpresso, Keil, IAR.
-
-
-\subpage md_doxygen_started_build_demo
-
-\subpage md_doxygen_started_device_demo
-
-\subpage md_doxygen_started_host_demo \ No newline at end of file
+[//]: # (\subpage md_doxygen_started_build_demo)
+[//]: # (\subpage md_doxygen_started_device_demo)
+[//]: # (\subpage md_doxygen_started_host_demo) \ No newline at end of file
diff --git a/doxygen/started_host_demo.md b/doxygen/started_host_demo.md
index a1bbc3a80..d632248a3 100644
--- a/doxygen/started_host_demo.md
+++ b/doxygen/started_host_demo.md
@@ -15,7 +15,7 @@
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-device application code is store at *demos/device/src* containing
+host application code is store at *demos/host/src* containing
File | Description
----- | -------------
diff --git a/readme.markdown b/readme.markdown
index 530b9cb58..d96b93e37 100644
--- a/readme.markdown
+++ b/readme.markdown
@@ -20,7 +20,7 @@
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
+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. More documents and API reference can be found at http://docs.tinyusb.org
![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png)
@@ -33,8 +33,7 @@ In addition to running without an RTOS, tinyusb is an OS-awared stack that can r
- HID Generic (comming soon)
- Communication Device Class (CDC)
- Mass Storage Class (MSC)
-- Hub
- - Only support 1 level of hub (due to my laziness)
+- Hub currnetly only support 1 level of hub (due to my laziness)
### Device ###
@@ -52,6 +51,14 @@ Currently the following OS are supported with tinyusb out of the box with a simp
- **FreeRTOS**
- **CMSIS RTX**
+### Toolchains ###
+
+You can compile with any of following toolchains
+
+- lpcxpresso
+- Keil MDK
+- IAR Workbench
+
### Supported MCUs ###
The stack supports the following MCUs
@@ -61,23 +68,15 @@ The stack supports the following MCUs
- LPC175x_6x
- LPC43xx
-[Here is the list of supported Boards](boards/) in the code base
-
-### Toolchains ###
-
-You can compile with any of following toolchains
-
-- *lpcxpresso/redsuite*
-- *Keil MDK*
-- *IAR Workbench*
+[Here is the list of supported Boards](boards/readme.md) in the code base
## Getting Started ##
-[Here is the details for getting started](doxygen/getting_started.md) with the stack
+[Here is the details for getting started](doxygen/getting_started.md) with the stack.
## License ##
-BSD license for most of the code base, but each file is individually licensed especially those in /vendor folder. Please make sure you understand all the license term for files you use in your project. [Full license here](tinyusb/license.md)
+BSD license for most of the code base, but each file is individually licensed especially those in *vendor* folder. Please make sure you understand all the license term for files you use in your project. [Full license is here](tinyusb/license.md)
## How Can I Help ##