summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorperigoso <[email protected]>2021-07-27 19:41:01 +0100
committerperigoso <[email protected]>2021-07-30 12:46:30 +0100
commita183e5a72b9195800ea79601b8a804319efb7cde (patch)
treead5a70927b690eff229c3bd49e2242838121bdc6 /docs/contributing
parente2d05bff9360b021fa3d3bec8dfcc09e1753d3ba (diff)
docs: add structure doc
Signed-off-by: perigoso <[email protected]>
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/structure.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/contributing/structure.rst b/docs/contributing/structure.rst
new file mode 100644
index 000000000..e8c658850
--- /dev/null
+++ b/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