begriffs open source - freertos/blob - README.md

   1 ## Getting started
   2 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.
   3
   4 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.
   5
   6 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).
   7
   8 ### Getting help
   9 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).
  10
  11 ## To consume FreeRTOS-Kernel
  12
  13 ### Consume with CMake
  14 If using CMake, it is recommended to use this repository using FetchContent.
  15 Add the following into your project's main or a subdirectory's `CMakeLists.txt`:
  16
  17 - Define the source and version/tag you want to use:
  18
  19 ```cmake
  20 FetchContent_Declare( freertos_kernel
  21   GIT_REPOSITORY https://github.com/FreeRTOS/FreeRTOS-Kernel.git
  22   GIT_TAG        master #Note: Best practice to use specific git-hash or tagged version
  23 )
  24 ```
  25
  26 - Add a freertos_config library (typically an INTERFACE library) The following assumes the directory structure:
  27   - `include/FreeRTOSConfig.h`
  28 ```cmake
  29 add_library(freertos_config INTERFACE)
  30
  31 target_include_directories(freertos_config SYSTEM
  32 INTERFACE
  33     include
  34 )
  35
  36 target_compile_definitions(freertos_config
  37   INTERFACE
  38     projCOVERAGE_TEST=0
  39 )
  40 ```
  41
  42 - Configure the FreeRTOS-Kernel and make it available
  43   - this particular example supports a native and cross-compiled build option.
  44
  45 ```cmake
  46 set( FREERTOS_HEAP "4" CACHE STRING "" FORCE)
  47 # Select the native compile PORT
  48 set( FREERTOS_PORT "GCC_POSIX" CACHE STRING "" FORCE)
  49 # Select the cross-compile PORT
  50 if (CMAKE_CROSSCOMPILING)
  51   set(FREERTOS_PORT "GCC_ARM_CA9" CACHE STRING "" FORCE)
  52 endif()
  53
  54 FetchContent_MakeAvailable(freertos_kernel)
  55 ```
  56
  57 ### Consuming stand-alone - Cloning this repository
  58
  59 To clone using HTTPS:
  60 ```
  61 git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git
  62 ```
  63 Using SSH:
  64 ```
  65 git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git
  66 ```
  67
  68 ## Repository structure
  69 - The root of this repository contains the three files that are common to
  70 every port - list.c, queue.c and tasks.c.  The kernel is contained within these
  71 three files.
  72
  73 - The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
  74 See the readme file in the ```./portable``` directory for more information.
  75
  76 - The ```./include``` directory contains the real time kernel header files.
  77
  78 ### Code Formatting
  79 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.
  80
  81 ### Line Endings
  82 File checked into the FreeRTOS-Kernel repository use unix-style LF line endings for the best compatbility with git.
  83
  84 For 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:
  85 ```
  86 git config core.autocrlf true
  87 ```
  88
  89 ### Git History Optimizations
  90 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 followig command:
  91 ```
  92 git config blame.ignoreRevsFile .git-blame-ignore-revs
  93 ```
  94
  95 ### Spelling
  96 *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*.
  97 Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.