summaryrefslogtreecommitdiffstats
path: root/tinyusb/docs/contributing/structure.rst
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-08-28 12:50:18 -0400
committerJoey Castillo <jose.castillo@gmail.com>2021-08-28 12:50:18 -0400
commit39a5c822a2a2e798e2e39ff8a98b7af84253026c (patch)
treefa157c98d3aea0d4f996e4415aa2a7ad1093ac05 /tinyusb/docs/contributing/structure.rst
parentc9e00b83bbdcb05058806d915ec4fff3cf4e596f (diff)
downloadSensor-Watch-39a5c822a2a2e798e2e39ff8a98b7af84253026c.tar.gz
Sensor-Watch-39a5c822a2a2e798e2e39ff8a98b7af84253026c.tar.bz2
Sensor-Watch-39a5c822a2a2e798e2e39ff8a98b7af84253026c.zip
add tinyusb
Diffstat (limited to 'tinyusb/docs/contributing/structure.rst')
-rwxr-xr-xtinyusb/docs/contributing/structure.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/tinyusb/docs/contributing/structure.rst b/tinyusb/docs/contributing/structure.rst
new file mode 100755
index 00000000..e8c65885
--- /dev/null
+++ b/tinyusb/docs/contributing/structure.rst
@@ -0,0 +1,59 @@
+*********
+Structure
+*********
+
+Tree
+====
+
+::
+
+ .
+ ├── docs
+ ├── examples
+ ├── hw
+ │   ├── bsp
+ │   └── mcu
+ ├── lib
+ ├── src
+ ├── test
+ └── tools
+
+docs
+----
+
+Documentation
+
+examples
+--------
+
+Sample with Makefile build support
+
+hw/bsp
+------
+
+Supported boards source files
+
+hw/mcu
+------
+
+Low level mcu core & peripheral drivers
+
+lib
+---
+
+Sources from 3rd party such as freeRTOS, fatfs ...
+
+src
+---
+
+All sources files for TinyUSB stack itself.
+
+test
+----
+
+Unit tests for the stack
+
+tools
+-----
+
+Files used internally