begriffs open source - freertos/blob - README.md

   1 # ![image](https://user-images.githubusercontent.com/56273942/202568467-0ee721bb-1424-4efd-88fc-31b4f2a59dc6.png) DEPRECATED
   2
   3 ## Announcement:
   4
   5 FreeRTOS SMP feature has been merged into [FreeRTOS-Kernel](https://github.com/FreeRTOS/FreeRTOS-Kernel/commit/ae3a498e435cecdb25b889f2740ea99027dd0cb1) main branch. We recommend you to use the [FreeRTOS-Kernel](https://github.com/FreeRTOS/FreeRTOS-Kernel/commit/ae3a498e435cecdb25b889f2740ea99027dd0cb1) main branch to develop FreeRTOS SMP applications.
   6
   7 The contents of this branch will remain available for certain period but we will no longer provide updates or accept new contributions and pull requests.
   8
   9 Have more questions? Post them in the [FreeRTOS forum](https://forums.freertos.org/).
  10
  11
  12
  13 ---
  14
  15 ## Getting started
  16 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.
  17
  18 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.
  19
  20 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).
  21
  22 ### Getting help
  23 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).
  24
  25 ## Cloning this repository
  26
  27 To clone using HTTPS:
  28 ```
  29 git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git
  30 ```
  31 Using SSH:
  32 ```
  33 git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git
  34 ```
  35
  36 ## Repository structure
  37 - The root of this repository contains the three files that are common to
  38 every port - list.c, queue.c and tasks.c.  The kernel is contained within these
  39 three files.  croutine.c implements the optional co-routine functionality - which
  40 is normally only used on very memory limited systems.
  41
  42 - The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
  43 See the readme file in the ```./portable``` directory for more information.
  44
  45 - The ```./include``` directory contains the real time kernel header files.
  46
  47 ### Code Formatting
  48 FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/master/tools/uncrustify.cfg).
  49
  50 ### Spelling
  51 *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*.
  52 Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.
  53