summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-12-29 14:29:59 +0700
committerhathach <[email protected]>2018-12-29 14:36:57 +0700
commit6b0a747d28088dd85fadf41517433cdac61b2212 (patch)
tree95e8eadbddfe3828dc2515c9b66d34df2fc83cf9
parent257d60fe1a2f72803fd7fa28cde691f5ca34a046 (diff)
update readme
-rw-r--r--README.md26
1 files changed, 16 insertions, 10 deletions
diff --git a/README.md b/README.md
index 18ae98d75..de21f94b2 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,25 @@
# TinyUSB
+[![Build Status](https://travis-ci.org/hathach/tinyusb.svg?branch=master)](https://travis-ci.org/hathach/tinyusb) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system.
![tinyusb](https://user-images.githubusercontent.com/249515/49858616-f60c9700-fe27-11e8-8627-e76936352ff7.png)
-Folder | Description
------ | -------------
-docs | Documentation
-examples| Sample applications are kept with Makefile and Segger Embedded build support
-hw/bsp | Source files of supported boards
-hw/mcu | Low level mcu core & peripheral drivers
-lib | Source files from 3rd party such as freeRTOS, fatfs etc ...
-src | All sources files for TinyUSB stack itself.
-tests | Unit tests for the stack
-tools | Files used internally
+```
+.
+├── docs # Documentation
+├── examples # Sample with Makefile and Segger Embedded build support
+├── hw
+│   ├── bsp # Supported boards source files
+│   └── mcu # Low level mcu core & peripheral drivers
+├── lib # Sources from 3rd party such as freeRTOS, fatfs ...
+├── src # All sources files for TinyUSB stack itself.
+├── tests # Unit tests for the stack
+└── tools # Files used internally
+```
+
+
## Device Stack