fd9c1eb7a5
Automate creation of doxygen ZIP output by using the custom doxygen GitHub Action, that has been updated to generate ZIP artifact in PR |
||
|---|---|---|
| .github | ||
| FreeRTOS | ||
| FreeRTOS-Plus | ||
| tools | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| FreeRTOS+TCP.url | ||
| GitHub-FreeRTOS-Home.url | ||
| History.txt | ||
| LICENSE.md | ||
| manifest.yml | ||
| Quick_Start_Guide.url | ||
| README.md | ||
| Upgrading to FreeRTOS V10.3.0.url | ||
| Upgrading-to-FreeRTOS-9.url | ||
| Upgrading-to-FreeRTOS-10.url | ||
| Upgrading-to-FreeRTOS-V10.4.0.url | ||
FreeRTOS includes libraries that are part of the FreeRTOS 202012.00 LTS release. Learn more about the FreeRTOS 202012.00 LTS libraries at https://freertos.org/lts-libraries.html.
Getting started
The FreeRTOS.org website contains contains a FreeRTOS Kernel Quick Start Guide, a list of supported devices and compilers, the API reference, and many other resources.
Getting help
You can use your Github login to get support from both the FreeRTOS community and directly from the primary FreeRTOS developers on our active support forum. The FAQ provides another support resource.
Cloning this repository
This repo uses Git Submodules to bring in dependent components.
Note: If you download the ZIP file provided by the GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
If using Windows, set core.symlinks to true since copying a directory with symlinks may cause hangups:
git config --global core.symlinks true
To clone using HTTPS:
git clone https://github.com/FreeRTOS/FreeRTOS.git --recurse-submodules
Using SSH:
git clone git@github.com:FreeRTOS/FreeRTOS.git --recurse-submodules
If you have downloaded the repo without using the --recurse-submodules argument, you need to run:
git submodule update --init --recursive
Repository structure
This repository contains the FreeRTOS Kernel, a number of supplementary libraries, and a comprehensive set of example applications. Many libraries (including the FreeRTOS kernel) are included as Git submodules from their own Git repositories.
Kernel source code and example projects
FreeRTOS/Source contains the FreeRTOS kernel source code (submoduled from https://github.com/FreeRTOS/FreeRTOS-Kernel).
FreeRTOS/Demo contains pre-configured example projects that demonstrate the FreeRTOS kernel executing on different hardware platforms and using different compilers.
Supplementary library source code and example projects
FreeRTOS-Plus/Source contains source code for additional FreeRTOS component libraries, as well as select partner provided libraries. These subdirectories contain further readme files and links to documentation.
FreeRTOS-Plus/Demo contains pre-configured example projects that demonstrate the FreeRTOS kernel used with the additional FreeRTOS component libraries.
Previous releases
Releases contains older FreeRTOS releases.
FreeRTOS Lab Projects
FreeRTOS Lab projects are libraries and demos that are fully functional, but may be experimental or undergoing optimizations and refactorization to improve memory usage, modularity, documentation, demo usability, or test coverage.
Most FreeRTOS Lab libraries can be found in the FreeRTOS-Labs repository.
A number of FreeRTOS Lab Demos can be found in the FreeRTOS Github Organization by searching for "Lab" or following this link to the search results.