mirror of
https://github.com/FreeRTOS/FreeRTOS-Kernel.git
synced 2025-12-08 12:45:22 -05:00
5d3b3cb1c7
* Update to the WolfSSL FIPS ready demo: Add a debug break point into the configASSERT() implementation along with a comment telling users how to update the integrity check hash if they hit the breakpoint. * Updates in the root directory: Remove "New - Stream and Message Buffers.url" as the feature is no longer new, and edit the readme.md file as the repo now contains 'core' libraries in addition to 'FreeRTOS+' libraries. * FreeRTOS-Plus/Source/Utilities: Add readme files and links to documentation. * Application-Protocols: Add readme and URL links. * Remove Index.html from the end of a URL in the readme.txt file. * Demo-IP-Protocols: Add readme.txt files and code comments saying the protocols are not intended for production use. * coreMQTT: Remove links to deprecated documentation, add readme and correct links to documentation. * General: Correct URLs in source files and .url files. * Update readme.txt
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
## Getting started
|
|
The [FreeRTOS.org](https://www.freertos.org) website contains contains a [FreeRTOS Kernel Quick Start Guide](https://www.freertos.org/FreeRTOS-quick-start-guide.html), a [list of supported devices and compilers](https://www.freertos.org/RTOS_ports.html), the [API reference](https://www.freertos.org/a00106.html), 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](https://forums.freertos.org). The [FAQ](https://www.freertos.org/FAQ.html) provides another support resource.
|
|
|
|
## Cloning this repository
|
|
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-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)
|
|
|
|
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](https://github.com/FreeRTOS/FreeRTOS/releases) contains older FreeRTOS releases.
|
|
|