1[](https://github.com/FreeRTOS/FreeRTOS-Kernel/actions/workflows/unit-tests.yml?query=branch%3Amain+event%3Apush+workflow%3A%22CMock+Unit+Tests%22++) 2[](https://codecov.io/gh/FreeRTOS/FreeRTOS-Kernel) 3## Getting started 4This 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 6The 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 8Additionally, 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 11If 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 16If using CMake, it is recommended to use this repository using FetchContent. 17Add 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 22FetchContent_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- Add a freertos_config library (typically an INTERFACE library) The following assumes the directory structure: 29 - `include/FreeRTOSConfig.h` 30```cmake 31add_library(freertos_config INTERFACE) 32 33target_include_directories(freertos_config SYSTEM 34INTERFACE 35 include 36) 37 38target_compile_definitions(freertos_config 39 INTERFACE 40 projCOVERAGE_TEST=0 41) 42``` 43 44- Configure the FreeRTOS-Kernel and make it available 45 - this particular example supports a native and cross-compiled build option. 46 47```cmake 48set( FREERTOS_HEAP "4" CACHE STRING "" FORCE) 49# Select the native compile PORT 50set( FREERTOS_PORT "GCC_POSIX" CACHE STRING "" FORCE) 51# Select the cross-compile PORT 52if (CMAKE_CROSSCOMPILING) 53 set(FREERTOS_PORT "GCC_ARM_CA9" CACHE STRING "" FORCE) 54endif() 55 56FetchContent_MakeAvailable(freertos_kernel) 57``` 58 59### Consuming stand-alone - Cloning this repository 60 61To clone using HTTPS: 62``` 63git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git 64``` 65Using SSH: 66``` 67git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git 68``` 69 70## Repository structure 71- The root of this repository contains the three files that are common to 72every port - list.c, queue.c and tasks.c. The kernel is contained within these 73three files. croutine.c implements the optional co-routine functionality - which 74is normally only used on very memory limited systems. 75 76- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler. 77See the readme file in the ```./portable``` directory for more information. 78 79- The ```./include``` directory contains the real time kernel header files. 80 81### Code Formatting 82FreeRTOS 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. 83 84### Line Endings 85File checked into the FreeRTOS-Kernel repository use unix-style LF line endings for the best compatbility with git. 86 87For optmial compatibility with Microsoft Windows tools, it is best to enable the git autocrlf feature. You can eanble this setting for the current repository using the following command: 88``` 89git config core.autocrlf true 90``` 91 92### Git History Optimizations 93Some 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 followig command: 94``` 95git config blame.ignoreRevsFile .git-blame-ignore-revs 96``` 97 98### Spelling 99*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*. 100Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored. 101
){kind=link}
){kind=link}