Merge pull request #983 from perigoso/docs

Docs

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