From 3cf5a383e066b0d86d1189a459892130ac8aeff7 Mon Sep 17 00:00:00 2001 From: hathach Date: Tue, 25 Mar 2014 23:47:51 +0700 Subject: rename markdown files --- boards/readme.markdown | 15 --------- boards/readme.md | 15 +++++++++ readme.markdown | 69 ++++++++++++++++++++++++++++++++++++++++++ readme.md | 69 ------------------------------------------ tests/readme.markdown | 16 ---------- tests/readme.md | 16 ++++++++++ tinyusb.Doxyfile | 6 ++-- tinyusb/doxygen/get_started.md | 0 8 files changed, 103 insertions(+), 103 deletions(-) delete mode 100644 boards/readme.markdown create mode 100644 boards/readme.md create mode 100644 readme.markdown delete mode 100644 readme.md delete mode 100644 tests/readme.markdown create mode 100644 tests/readme.md create mode 100644 tinyusb/doxygen/get_started.md diff --git a/boards/readme.markdown b/boards/readme.markdown deleted file mode 100644 index 1737f3aa5..000000000 --- a/boards/readme.markdown +++ /dev/null @@ -1,15 +0,0 @@ -# Boards # - -## Supported Boards ## - -this code base already had supported a handful of boards. However due to my limited arsenal, **only bold ones are (probably) guaranteed to run out of the box**. Other are merely implemented based on their schematics and need help from you to make it work. - -### NXP MCU ### - -- [LPCXpresso 11u14](http://www.embeddedartists.com/products/lpcxpresso/lpc11U14_xpr.php) with base board (for some peripherals to work) -- **[Microbuilder RF1GHZNODE](http://www.microbuilder.eu/Blog/13-03-14/LPC1xxx_1GHZ_Wireless_Board_Preview.aspx)** equipped with LPC11u37 -- **[LPCXpresso 1347](http://www.embeddedartists.com/products/lpcxpresso/lpc1347_xpr.php)** with base board (for some peripherals to work) -- **[LPCXpresso 1769](http://www.embeddedartists.com/products/lpcxpresso/lpc1347_xpr.php)** with base board (for some peripherals to work) -- **[Embedded Artists LPC4357 OEM & Base board](http://www.embeddedartists.com/products/kits/lpc4357_kit.php)** -- **[NGX LPC4330 Explorer](http://shop.ngxtechnologies.com/product_info.php?products_id=104)** -- [Keil MCB4357 Evaluation Board](http://www.keil.com/mcb4300) diff --git a/boards/readme.md b/boards/readme.md new file mode 100644 index 000000000..1737f3aa5 --- /dev/null +++ b/boards/readme.md @@ -0,0 +1,15 @@ +# Boards # + +## Supported Boards ## + +this code base already had supported a handful of boards. However due to my limited arsenal, **only bold ones are (probably) guaranteed to run out of the box**. Other are merely implemented based on their schematics and need help from you to make it work. + +### NXP MCU ### + +- [LPCXpresso 11u14](http://www.embeddedartists.com/products/lpcxpresso/lpc11U14_xpr.php) with base board (for some peripherals to work) +- **[Microbuilder RF1GHZNODE](http://www.microbuilder.eu/Blog/13-03-14/LPC1xxx_1GHZ_Wireless_Board_Preview.aspx)** equipped with LPC11u37 +- **[LPCXpresso 1347](http://www.embeddedartists.com/products/lpcxpresso/lpc1347_xpr.php)** with base board (for some peripherals to work) +- **[LPCXpresso 1769](http://www.embeddedartists.com/products/lpcxpresso/lpc1347_xpr.php)** with base board (for some peripherals to work) +- **[Embedded Artists LPC4357 OEM & Base board](http://www.embeddedartists.com/products/kits/lpc4357_kit.php)** +- **[NGX LPC4330 Explorer](http://shop.ngxtechnologies.com/product_info.php?products_id=104)** +- [Keil MCB4357 Evaluation Board](http://www.keil.com/mcb4300) diff --git a/readme.markdown b/readme.markdown new file mode 100644 index 000000000..7bc71a5c2 --- /dev/null +++ b/readme.markdown @@ -0,0 +1,69 @@ +# tinyusb # + +## What Is tinyusb ## + +tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controller. It is developed using [Test-Driven Development (TDD)](tests/readme.md) approach to eliminate bugs as soon as possible. + +![tinyusb diagram](/docs/images/what_is_tinyusb.png) + +## Features ## + +designed to be simple and run out-of-the-box provided the configuration is correct. + +### Host ### + +- HID Mouse +- HID Keyboard +- HID Generic (comming soon) +- Communication Device Class (CDC) +- Mass Storage Class (MSC) +- Hub + - Only support 1 level of hub (due to my laziness) + +### Device ### + +- HID Mouse +- HID Keyboard +- HID Generic (comming soon) +- Communication Class (CDC) +- Mass Storage Class (MSC) + +### RTOS ### + +tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS Abstraction Layer (OSAL). However, it can also run without an RTOS (OSAL will be expanded to be a state machine in this case). Currently the following OS can be run with tinyusb (out of the box). + +- **None OS** +- **FreeRTOS** +- **CMSIS RTX** + +## Getting Started ## + +coming soon ... + +## Supported MCUs ## + +- NXP + - LPC11uxx + - LPC13uxx (12 bit ADC) + - LPC175x_6x + - LPC43xx + +## Supported Toolchains ## + +The following toolchains are supported + +- *lpcxpresso/redsuite* +- *Keil MDK* +- *IAR Workbench* + +## Known Issues ## + +- LPC11uxx & LPC13uxx cannot able to STALL Control OUT endpoint !!! --> unsupported with data out request may cause host stuck with control transfer forever. (reproduce: enable keyboard + mouse, return error in set report of hid_device) + +## How Can I Help ## + +If you find my little USB stack is useful, please take some time to file any issues that you encountered. It is not necessary to be a software bug, it can be a question, request, suggestion etc. We can consider each github's issue as a forum's topic. Alternatively, you can buy me a cup of coffee if you happen to be in Hochiminh city. + +## 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) diff --git a/readme.md b/readme.md deleted file mode 100644 index 7bc71a5c2..000000000 --- a/readme.md +++ /dev/null @@ -1,69 +0,0 @@ -# tinyusb # - -## What Is tinyusb ## - -tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controller. It is developed using [Test-Driven Development (TDD)](tests/readme.md) approach to eliminate bugs as soon as possible. - -![tinyusb diagram](/docs/images/what_is_tinyusb.png) - -## Features ## - -designed to be simple and run out-of-the-box provided the configuration is correct. - -### Host ### - -- HID Mouse -- HID Keyboard -- HID Generic (comming soon) -- Communication Device Class (CDC) -- Mass Storage Class (MSC) -- Hub - - Only support 1 level of hub (due to my laziness) - -### Device ### - -- HID Mouse -- HID Keyboard -- HID Generic (comming soon) -- Communication Class (CDC) -- Mass Storage Class (MSC) - -### RTOS ### - -tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS Abstraction Layer (OSAL). However, it can also run without an RTOS (OSAL will be expanded to be a state machine in this case). Currently the following OS can be run with tinyusb (out of the box). - -- **None OS** -- **FreeRTOS** -- **CMSIS RTX** - -## Getting Started ## - -coming soon ... - -## Supported MCUs ## - -- NXP - - LPC11uxx - - LPC13uxx (12 bit ADC) - - LPC175x_6x - - LPC43xx - -## Supported Toolchains ## - -The following toolchains are supported - -- *lpcxpresso/redsuite* -- *Keil MDK* -- *IAR Workbench* - -## Known Issues ## - -- LPC11uxx & LPC13uxx cannot able to STALL Control OUT endpoint !!! --> unsupported with data out request may cause host stuck with control transfer forever. (reproduce: enable keyboard + mouse, return error in set report of hid_device) - -## How Can I Help ## - -If you find my little USB stack is useful, please take some time to file any issues that you encountered. It is not necessary to be a software bug, it can be a question, request, suggestion etc. We can consider each github's issue as a forum's topic. Alternatively, you can buy me a cup of coffee if you happen to be in Hochiminh city. - -## 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) diff --git a/tests/readme.markdown b/tests/readme.markdown deleted file mode 100644 index d96b8c64b..000000000 --- a/tests/readme.markdown +++ /dev/null @@ -1,16 +0,0 @@ -# Test-Driven Development (TDD) # - -TDD indeed works with C & embedded with the help of Ceedling, Unity & CMock as a testing framework. - -comming soon - -More detail on TDD can be found at - -- [James W. Grenning's book "Test Driven Development for Embedded C"](http://www.amazon.com/Driven-Development-Embedded-Pragmatic-Programmers/dp/193435662X) -- [throwtheswitch's Ceedling, CMock & Unity](http://throwtheswitch.org/) - -## Continuous Integration ## - -comming soon - -[![Build Status](https://travis-ci.org/hathach/tinyusb.png?branch=master)](https://travis-ci.org/hathach/tinyusb) diff --git a/tests/readme.md b/tests/readme.md new file mode 100644 index 000000000..d96b8c64b --- /dev/null +++ b/tests/readme.md @@ -0,0 +1,16 @@ +# Test-Driven Development (TDD) # + +TDD indeed works with C & embedded with the help of Ceedling, Unity & CMock as a testing framework. + +comming soon + +More detail on TDD can be found at + +- [James W. Grenning's book "Test Driven Development for Embedded C"](http://www.amazon.com/Driven-Development-Embedded-Pragmatic-Programmers/dp/193435662X) +- [throwtheswitch's Ceedling, CMock & Unity](http://throwtheswitch.org/) + +## Continuous Integration ## + +comming soon + +[![Build Status](https://travis-ci.org/hathach/tinyusb.png?branch=master)](https://travis-ci.org/hathach/tinyusb) diff --git a/tinyusb.Doxyfile b/tinyusb.Doxyfile index 5f92c1cee..8be8b1678 100644 --- a/tinyusb.Doxyfile +++ b/tinyusb.Doxyfile @@ -744,10 +744,10 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = tinyusb/doxygen/group_def.txt \ - readme.md \ + readme.markdown \ tinyusb \ boards \ - tests/readme.markdown + tests/readme.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -925,7 +925,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = readme.md +USE_MDFILE_AS_MAINPAGE = readme.markdown #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/tinyusb/doxygen/get_started.md b/tinyusb/doxygen/get_started.md new file mode 100644 index 000000000..e69de29bb -- cgit v1.3.1