From a183e5a72b9195800ea79601b8a804319efb7cde Mon Sep 17 00:00:00 2001 From: perigoso Date: Tue, 27 Jul 2021 19:41:01 +0100 Subject: [PATCH] docs: add structure doc Signed-off-by: perigoso --- docs/contributing/structure.rst | 59 +++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/contributing/structure.rst diff --git a/docs/contributing/structure.rst b/docs/contributing/structure.rst new file mode 100644 index 00000000..e8c65885 --- /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