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

   1 # CMSIS-FreeRTOS
   2 FreeRTOS adaptation for CMSIS-RTOS API Version 2.
   3
   4 The GitHub repository's development branch reflects the current state of development and is constantly updated.
   5
   6 ## Directory Structure
   7
   8 | Directory                     | Content                           |
   9 | ----------------------------- | --------------------------------- |
  10 | CMSIS                         | CMSIS-FreeRTOS related files      |
  11 | CMSIS/RTOS2/FreeRTOS/Config   | CMSIS-FreeRTOS configuration file |
  12 | CMSIS/RTOS2/FreeRTOS/Examples | CMSIS-FreeRTOS example projects   |
  13 | CMSIS/RTOS2/FreeRTOS/Source   | CMSIS-FreeRTOS source code        |
  14 | Config                        | FreeRTOS configuration file       |
  15 | Demo                          | FreeRTOS demo projects            |
  16 | DoxyGen                       | Source of the documentation       |
  17 | License                       | FreeRTOS license text file        |
  18 | Source                        | FreeRTOS source code              |
  19 | Utilities                     | Utility programs                  |
  20
  21 ## Generate CMSIS Pack for Release
  22
  23 This GitHub development repository contains all the sources you need to successfully build the pack.
  24
  25 To build the complete pack for installation, the following additional tools are required:
  26  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  27  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  28  - **7z.exe (7-Zip)** Version: 16.04 (File Archiver)
  29
  30 Using these tools, you can generate on a Windows PC:
  31  - **CMSIS-FreeRTOS software pack** using the batch file **gen_pack.bat** (located in ./Utilities). This batch file also
  32    generates the documentation.
  33
  34  - **CMSIS-FreeRTOS documentation** using the batch file **genDoc.bat** (located in ./Doxygen).
  35
  36 The file ./DoxyGen/How2Doc.txt describes the rules for creating API documentation.
  37
  38 ## License
  39
  40 CMSIS-FreeRTOS is licensed under the FreeRTOS license.