From 9586cef15da0dfdb644509f460e79385b9015ad3 Mon Sep 17 00:00:00 2001 From: Tim Ansell Date: Tue, 13 Nov 2018 10:33:51 -0800 Subject: [PATCH 1/2] Use more standard name for README.md --- readme.markdown => README.md | 174 +++++++++++++++++------------------ 1 file changed, 87 insertions(+), 87 deletions(-) rename readme.markdown => README.md (97%) diff --git a/readme.markdown b/README.md similarity index 97% rename from readme.markdown rename to README.md index 0715adfd4..d90d6949d 100644 --- a/readme.markdown +++ b/README.md @@ -1,97 +1,97 @@ -# tinyusb # - - - -**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) - - - -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. More documents and API reference can be found at http://docs.tinyusb.org - -![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png) - -## Features ## - -### Host ### - -- HID Mouse -- HID Keyboard -- HID Generic (comming soon) -- Communication Device Class (CDC) -- Mass Storage Class (MSC) -- Hub currnetly only support 1 level of hub (due to my laziness) - -### Device ### - -- HID Mouse +# tinyusb # + + + +**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) + + + +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. More documents and API reference can be found at http://docs.tinyusb.org + +![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png) + +## Features ## + +### Host ### + +- HID Mouse - HID Keyboard - HID Generic (comming soon) -- Communication Class (CDC) -- Mass Storage Class (MSC) - -### RTOS ### - -Currently the following OS are supported with tinyusb out of the box with a simple change of TUSB_CFG_OS macro. - -- **None OS** -- **FreeRTOS** -- **CMSIS RTX** - -### Toolchains ### - -You can compile with any of following toolchains, however, the stack requires C99 to build with - -- lpcxpresso -- Keil MDK +- Communication Device Class (CDC) +- Mass Storage Class (MSC) +- Hub currnetly 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 ### + +Currently the following OS are supported with tinyusb out of the box with a simple change of TUSB_CFG_OS macro. + +- **None OS** +- **FreeRTOS** +- **CMSIS RTX** + +### Toolchains ### + +You can compile with any of following toolchains, however, the stack requires C99 to build with + +- lpcxpresso +- Keil MDK - IAR Workbench - -### Supported MCUs ### - + +### Supported MCUs ### + The stack supports the following MCUs - LPC11uxx - LPC13uxx (12 bit ADC) - LPC175x_6x - LPC43xx - -[Here is the list of supported Boards](boards/readme.md) in the code base - -## Getting Started ## - + +[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. - -## 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 is here](tinyusb/license.md) - -## How Can I Help ## - -If you find my little USB stack is useful and want to give something back - -### Donate Time ### - -You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it. - -### Donate Money ### - -If you don't have time but still want to help, then please consider making a financial donation. This will help to pay the (mostly coffee) bills and motivate me to continue working on tinyusb. You can do so using the donation button, or contact me for other payment methods. - -[//]: # (\htmlonly) -Click here to lend your support to tinyusb donation and make a donation at pledgie.com -[//]: # (\endhtmlonly) - - + +## 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 is here](tinyusb/license.md) + +## How Can I Help ## + +If you find my little USB stack is useful and want to give something back + +### Donate Time ### + +You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it. + +### Donate Money ### + +If you don't have time but still want to help, then please consider making a financial donation. This will help to pay the (mostly coffee) bills and motivate me to continue working on tinyusb. You can do so using the donation button, or contact me for other payment methods. + +[//]: # (\htmlonly) +Click here to lend your support to tinyusb donation and make a donation at pledgie.com +[//]: # (\endhtmlonly) + + From 3b038c05dfd57dd6cabd8b0f7afc512dd900c841 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Tue, 13 Nov 2018 16:24:21 -0800 Subject: [PATCH 2/2] README: Fix spelling mistakes. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d90d6949d..d007fa52f 100644 --- a/README.md +++ b/README.md @@ -30,16 +30,16 @@ In addition to running without an RTOS, tinyusb is an OS-awared stack that can r - HID Mouse - HID Keyboard -- HID Generic (comming soon) +- HID Generic (coming soon) - Communication Device Class (CDC) - Mass Storage Class (MSC) -- Hub currnetly only support 1 level of hub (due to my laziness) +- Hub currently only support 1 level of hub (due to my laziness) ### Device ### - HID Mouse - HID Keyboard -- HID Generic (comming soon) +- HID Generic (coming soon) - Communication Class (CDC) - Mass Storage Class (MSC) @@ -84,7 +84,7 @@ If you find my little USB stack is useful and want to give something back ### Donate Time ### -You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it. +You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it. ### Donate Money ###