]> begriffs open source - cmsis-freertos/blob - README.md
chore(deps): bump actions/checkout from 4 to 5 in /.github/workflows
[cmsis-freertos] / README.md
1 # CMSIS-FreeRTOS
2
3 This repository contains the CMSIS-RTOS adoption of [FreeRTOS-Kernel Version 11.2.0](https://github.com/FreeRTOS/FreeRTOS-Kernel/releases/download/V11.2.0/FreeRTOS-KernelV11.2.0.zip) as it is released as Software Pack on http://www.keil.com/pack. The [documentation](https://arm-software.github.io/CMSIS-FreeRTOS/) is available under https://arm-software.github.io/CMSIS-FreeRTOS/.
4
5 Use *Issues* to provide feedback and report problems for CMSIS FreeRTOS implementation.
6
7 Use *main* branch for pull-requests.
8
9 ## Directory Structure
10
11 | Directory                     | Content                             |                
12 | ----------------------------- | ------------------------------------|
13 | CMSIS                         | CMSIS-FreeRTOS related files        |
14 | CMSIS/RTOS2/FreeRTOS/Config   | CMSIS-FreeRTOS configuration file   |
15 | CMSIS/RTOS2/FreeRTOS/Examples | CMSIS-FreeRTOS example projects     |
16 | CMSIS/RTOS2/FreeRTOS/Source   | CMSIS-FreeRTOS source code          |
17 | Documentation                 | Source of the documentation         |
18 | Source                        | FreeRTOS Kernel source code         |
19
20 ## Generate CMSIS Pack for Release
21
22 This GitHub development repository contains all the sources you need to successfully build the pack.
23
24 To build the complete pack for installation use the **gen_pack.sh** bash script. This script file also
25 generates the documentation.
26
27 Documentation may be generated separately using the bash script **gen_doc.sh** (located in ./Documentation/Doxygen).
28
29 ## License
30
31 The FreeRTOS kernel source files are released under the MIT open source license (read [LICENSE.md](./Source/LICENSE.md)).
32 The rest of the repository content is covered by Apache 2.0 license (read [LICENSE](./LICENSE)).