begriffs open source - freertos/blob - README.md

   1 [![CMock Unit Tests](https://github.com/FreeRTOS/FreeRTOS-Kernel/actions/workflows/unit-tests.yml/badge.svg?branch=main&event=push)](https://github.com/FreeRTOS/FreeRTOS-Kernel/actions/workflows/unit-tests.yml?query=branch%3Amain+event%3Apush+workflow%3A%22CMock+Unit+Tests%22++)
   2 [![codecov](https://codecov.io/gh/FreeRTOS/FreeRTOS-Kernel/badge.svg?branch=main)](https://codecov.io/gh/FreeRTOS/FreeRTOS-Kernel)
   3 ## Getting started
   4 This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository, which contains pre-configured demo application projects under ```FreeRTOS/Demo``` directory.
   5
   6 The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects.  That way you will have the correct FreeRTOS source files included, and the correct include paths configured.  Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files.  See the [FreeRTOS Kernel Quick Start Guide](https://www.FreeRTOS.org/FreeRTOS-quick-start-guide.html) for detailed instructions and other useful links.
   7
   8 Additionally, for FreeRTOS kernel feature information refer to the [Developer Documentation](https://www.FreeRTOS.org/features.html), and [API Reference](https://www.FreeRTOS.org/a00106.html).
   9
  10 ### Getting help
  11 If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org).
  12
  13 ## To consume FreeRTOS-Kernel
  14
  15 ### Consume with CMake
  16 If using CMake, it is recommended to use this repository using FetchContent.
  17 Add the following into your project's main or a subdirectory's `CMakeLists.txt`:
  18
  19 - Define the source and version/tag you want to use:
  20
  21 ```cmake
  22 FetchContent_Declare( freertos_kernel
  23   GIT_REPOSITORY https://github.com/FreeRTOS/FreeRTOS-Kernel.git
  24   GIT_TAG        main #Note: Best practice to use specific git-hash or tagged version
  25 )
  26 ```
  27
  28 In case you prefer to add it as a git submodule, do:
  29
  30 ```bash
  31 $ git submodule add https://github.com/FreeRTOS/FreeRTOS-Kernel.git <path of the submodule>
  32 $ git submodule update --init
  33 ```
  34
  35 - Add a freertos_config library (typically an INTERFACE library) The following assumes the directory structure:
  36   - `include/FreeRTOSConfig.h`
  37 ```cmake
  38 add_library(freertos_config INTERFACE)
  39
  40 target_include_directories(freertos_config SYSTEM
  41 INTERFACE
  42     include
  43 )
  44
  45 target_compile_definitions(freertos_config
  46   INTERFACE
  47     projCOVERAGE_TEST=0
  48 )
  49 ```
  50
  51 In case you installed FreeRTOS-Kernel as a submodule, you will have to add it as a subdirectory:
  52
  53 ```cmake
  54 add_subdirectory(${FREERTOS_PATH})
  55 ```
  56
  57 - Configure the FreeRTOS-Kernel and make it available
  58   - this particular example supports a native and cross-compiled build option.
  59
  60 ```cmake
  61 set( FREERTOS_HEAP "4" CACHE STRING "" FORCE)
  62 # Select the native compile PORT
  63 set( FREERTOS_PORT "GCC_POSIX" CACHE STRING "" FORCE)
  64 # Select the cross-compile PORT
  65 if (CMAKE_CROSSCOMPILING)
  66   set(FREERTOS_PORT "GCC_ARM_CA9" CACHE STRING "" FORCE)
  67 endif()
  68
  69 FetchContent_MakeAvailable(freertos_kernel)
  70 ```
  71
  72 - In case of cross compilation, you should also add the following to `freertos_config`:
  73
  74 ```cmake
  75 target_compile_definitions(freertos_config INTERFACE ${definitions})
  76 target_compile_options(freertos_config INTERFACE ${options})
  77 ```
  78
  79 ### Consuming stand-alone - Cloning this repository
  80
  81 To clone using HTTPS:
  82 ```
  83 git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git
  84 ```
  85 Using SSH:
  86 ```
  87 git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git
  88 ```
  89
  90 ## Repository structure
  91 - The root of this repository contains the three files that are common to
  92 every port - list.c, queue.c and tasks.c.  The kernel is contained within these
  93 three files.  croutine.c implements the optional co-routine functionality - which
  94 is normally only used on very memory limited systems.
  95
  96 - The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
  97 See the readme file in the ```./portable``` directory for more information.
  98
  99 - The ```./include``` directory contains the real time kernel header files.
 100
 101 ### Code Formatting
 102 FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [.github/uncrustify.cfg](.github/uncrustify.cfg) file.
 103
 104 ### Line Endings
 105 File checked into the FreeRTOS-Kernel repository use unix-style LF line endings for the best compatibility with git.
 106
 107 For optimal compatibility with Microsoft Windows tools, it is best to enable the git autocrlf feature. You can enable this setting for the current repository using the following command:
 108 ```
 109 git config core.autocrlf true
 110 ```
 111
 112 ### Git History Optimizations
 113 Some commits in this repository perform large refactors which touch many lines and lead to unwanted behavior when using the `git blame` command. You can configure git to ignore the list of large refactor commits in this repository with the following command:
 114 ```
 115 git config blame.ignoreRevsFile .git-blame-ignore-revs
 116 ```
 117
 118 ### Spelling
 119 *lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to *lexicon.txt*.
 120 Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.