summaryrefslogtreecommitdiff
path: root/docs/contributing/structure.rst
diff options
context:
space:
mode:
authornxf58843 <[email protected]>2021-08-23 09:55:04 -0700
committerGitHub <[email protected]>2021-08-23 09:55:04 -0700
commitfb16e80e575a44828f5367f4fb7380162b0354f0 (patch)
treebb965cc935083d99e083667d4f0f1533d50a29f5 /docs/contributing/structure.rst
parent616562a48aa1d8ce2f4ca71f6e780a8bec9fb5eb (diff)
parentea902493db49843dcdeca6bfa2b2efe540f44b2f (diff)
Merge pull request #2 from hathach/master
Pulling latest from source
Diffstat (limited to 'docs/contributing/structure.rst')
-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