diff options
Diffstat (limited to 'readme.txt')
| -rw-r--r-- | readme.txt | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt new file mode 100644 index 000000000..963376c88 --- /dev/null +++ b/readme.txt @@ -0,0 +1,77 @@ +*****************************************************************************
+*** Files Organization ***
+*****************************************************************************
+
+--{root} - ChibiOS/RT directory.
+ +--readme.txt - This file.
+ +--documentation.html - Shortcut to the web documentation page.
+ +--license.txt - GPL license text.
+ +--exception.txt - GPL exception text (stable releases only).
+ +--demos/ - Demo projects, one directory per platform.
+ +--docs/ - Documentation.
+ | +--common/ - Documentation common build resources.
+ | +--hal/ - Builders for HAL.
+ | | +--Doxyfile_* - Doxygen project files (required for rebuild).
+ | | +--html/ - Local HTML documentation (after rebuild).
+ | | +--reports/ - Test reports.
+ | | +--rsc/ - Documentation resource files (required for rebuild).
+ | | +--src/ - Documentation source files (required for rebuild).
+ | | +--Doxyfile_* - Doxygen project files (required for rebuild).
+ | | +--index.html - Local documentation access (after rebuild).
+ | +--nil/ - Builders for NIL.
+ | | +--Doxyfile_* - Doxygen project files (required for rebuild).
+ | | +--html/ - Local HTML documentation (after rebuild).
+ | | +--reports/ - Test reports.
+ | | +--rsc/ - Documentation resource files (required for rebuild).
+ | | +--src/ - Documentation source files (required for rebuild).
+ | | +--Doxyfile_* - Doxygen project files (required for rebuild).
+ | | +--index.html - Local documentation access (after rebuild).
+ | +--rt/ - Builders for RT.
+ | | +--html/ - Local HTML documentation (after rebuild).
+ | | +--reports/ - Test reports.
+ | | +--rsc/ - Documentation resource files (required for rebuild).
+ | | +--src/ - Documentation source files (required for rebuild).
+ | | +--Doxyfile_* - Doxygen project files (required for rebuild).
+ | | +--index.html - Local documentation access (after rebuild).
+ +--ext/ - External libraries, not part of ChibiOS/RT.
+ +--os/ - ChibiOS components.
+ | +--hal/ - HAL component.
+ | | +--boards/ - HAL board support files.
+ | | +--dox/ - HAL documentation resources.
+ | | +--include/ - HAL high level headers.
+ | | +--lib/ - HAL libraries.
+ | | +--osal/ - HAL OSAL implementations.
+ | | +--src/ - HAL high level source.
+ | | +--ports/ - HAL ports.
+ | | +--templates/ - HAL driver template files.
+ | | +--osal/ - HAL OSAL templates.
+ | +--nil/ - NIL RTOS component.
+ | | +--dox/ - NIL documentation resources.
+ | | +--include/ - NIL high level headers.
+ | | +--src/ - NIL high level source.
+ | | +--ports/ - NIL ports.
+ | | +--templates/ - NIL port template files.
+ | +--rt/ - RT RTOS component.
+ | | +--dox/ - RT documentation resources.
+ | | +--include/ - RT high level headers.
+ | | +--src/ - RT high level source.
+ | | +--ports/ - RT ports.
+ | | +--templates/ - RT port template files.
+ | +--various/ - Various portable support files.
+ +--test/ - Kernel test suite source code.
+ | +--lib\ - Portable test engine.
+ | +--hal\ - HAL test suites.
+ | | +--testbuild/ - HAL uild test and MISRA check.
+ | +--nil\ - NIL test suites.
+ | | +--testbuild/ - NIL nuild test and MISRA check.
+ | +--rt\ - RT test suites.
+ | | +--testbuild/ - RT build test and MISRA check.
+ | | +--coverage/ - RT code coverage project.
+ +--testhal/ - HAL integration test demos.
+
+*****************************************************************************
+*** Releases and Change Log ***
+*****************************************************************************
+
+*** 3.0.0p1 ***
+- First 3.0.0 release, see release note 3.0.0.
|