begriffs open source - cmsis-freertos/blob - README.md

   1 # CMSIS-FreeRTOS
   2
   3 This repository contains the CMSIS-RTOS adoption of [FreeRTOS Version 10.4.6](https://github.com/FreeRTOS/FreeRTOS/releases/download/202111.00/FreeRTOSv202111.00.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 Note: Branches *develop* and *master* will be deprecated. Please update your fork and switch to branch *main* to track the latest state of development.
  10
  11 ## Directory Structure
  12
  13 | Directory                     | Content                            |
  14 | ----------------------------- | -----------------------------------|
  15 | CMSIS                         | CMSIS-FreeRTOS related files       |
  16 | CMSIS/RTOS2/FreeRTOS/Config   | CMSIS-FreeRTOS configuration file  |
  17 | CMSIS/RTOS2/FreeRTOS/Examples | CMSIS-FreeRTOS example projects    |
  18 | CMSIS/RTOS2/FreeRTOS/Source   | CMSIS-FreeRTOS source code         |
  19 | Config                        | FreeRTOS Kernel configuration file |
  20 | Demo                          | FreeRTOS demo projects             |
  21 | DoxyGen                       | Source of the documentation        |
  22 | License                       | FreeRTOS Kernel license text file  |
  23 | Source                        | FreeRTOS Kernel source code        |
  24 | Utilities                     | Utility programs                   |
  25
  26 ## Generate CMSIS Pack for Release
  27
  28 This GitHub development repository contains all the sources you need to successfully build the pack.
  29
  30 To build the complete pack for installation, the following additional tools are required:
  31  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  32  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  33  - **7z.exe (7-Zip)** Version: 16.04 (File Archiver)
  34
  35 Using these tools, you can generate on a Windows PC:
  36  - **CMSIS-FreeRTOS software pack** using the batch file **gen_pack.bat** (located in ./Utilities). This batch file also
  37    generates the documentation.
  38
  39  - **CMSIS-FreeRTOS documentation** using the batch file **genDoc.bat** (located in ./Doxygen).
  40
  41 The file ./DoxyGen/How2Doc.txt describes the rules for creating API documentation.
  42
  43 ## License
  44
  45 The FreeRTOS kernel is released under the MIT open source license (see License/license.txt).