This repo uses Git Submodules to bring in dependent components.
Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
To clone using HTTPS:
git clone https://github.com/aws/amazon-freertos.git --recurse-submodules
Using SSH:
git clone git@github.com:aws/amazon-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
master --> Development is done continuously on this branch
release --> Fully tested released source code
release-candidate --> Preview of upcoming release
feature/* --> Alpha/beta of an upcoming feature
For more information on FreeRTOS, refer to the Getting Started section of FreeRTOS webpage.
To directly access the Getting Started Guide for supported hardware platforms, click the corresponding link in the Supported Hardware section below.
For detailed documentation on FreeRTOS, refer to the FreeRTOS User Guide.
For additional boards that are supported for FreeRTOS, please visit the AWS Device Catalog
The following MCU boards are supported for FreeRTOS:
The ./projects folder contains the IDE test and demo projects for each vendor and their boards. The majority of boards can be built with both IDE and cmake (there are some exceptions!). Please refer to the Getting Started Guides above for board specific instructions.