aboutsummaryrefslogtreecommitdiffstats
path: root/os/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'os/readme.txt')
-rw-r--r--os/readme.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/os/readme.txt b/os/readme.txt
new file mode 100644
index 000000000..1c69d9a98
--- /dev/null
+++ b/os/readme.txt
@@ -0,0 +1,29 @@
+*****************************************************************************
+*** ChibiOS products directory organization ***
+*****************************************************************************
+
+--{root} - Distribution directory.
+ +--os/ - ChibiOS products, this directory.
+ | +--ext/ - Vendor files.
+ | +--common/ - Files used by multiple ChibiOS products.
+ | | +--ports - Common port files for various architectures and
+ | | compilers.
+ | +--hal/ - Hardware Abstraction Layer product.
+ | | +--include/ - HAL high level headers.
+ | | +--src/ - HAL high level sources.
+ | | +--platforms/ - HAL low level drivers implementations.
+ | | +--templates/ - Driver template files.
+ | | +--meta/ - Driver meta templates.
+ | +--rt/ - ChibiOS/RT kernel portable files.
+ | | +--include/ - RT kernel headers.
+ | | +--src/ - RT kernel sources.
+ | | +--templates/ - RT kernel port template files.
+ | | +--ports - RT kernel port files for various architectures and
+ | | compilers.
+ | +--nil/ - ChibiOS/NIL kernel portable files.
+ | | +--include/ - Nil kernel headers.
+ | | +--src/ - Nil kernel sources.
+ | | +--templates/ - Nil kernel port template files.
+ | | +--ports - Nil kernel port files for various architectures and
+ | | compilers.
+ | +--various/ - Various portable support files.