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

   1 # CMSIS-FreeRTOS
   2
   3 This repository contains the CMSIS-RTOS adoption of [FreeRTOS-Kernel Version 10.5.1](https://github.com/FreeRTOS/FreeRTOS-Kernel/releases/download/V10.5.1/FreeRTOS-KernelV10.5.1.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 | Documentation                 | Generated documentation placeholder |
  21 | DoxyGen                       | Source of the documentation         |
  22 | License                       | FreeRTOS Kernel license text file   |
  23 | Source                        | FreeRTOS Kernel source code         |
  24
  25 ## Generate CMSIS Pack for Release
  26
  27 This GitHub development repository contains all the sources you need to successfully build the pack.
  28
  29 To build the complete pack for installation use the **gen_pack.sh** bash script. This script file also
  30 generates the documentation.
  31
  32 Documentation may be generated separately using the bash script **gen_doc.sh** (located in ./DoxyGen).
  33
  34 **_NOTE_**
  35 > Repository tags have to be updated to successfully generate the pack. To update them, use: </br>
  36 > ```$ git fetch -f --prune --prune-tags origin```</br>
  37 > When working with an existing fork replace 'origin' with the parent repository URL</br>
  38 > ```$ git fetch -f --prune --prune-tags https://github.com/ARM-software/CMSIS-FreeRTOS.git```</br>
  39
  40
  41 ## License
  42
  43 The FreeRTOS kernel source files are released under the MIT open source license (read [LICENSE.md](./Source/LICENSE.md)).
  44 The rest of the repository content is covered by Apache 2.0 license (read [LICENSE](./LICENSE)).