forked from aws/amazon-freertos
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replacing readme.txt with README.md. (aws#11)
- Loading branch information
1 parent
10bbbcf
commit 08c9c91
Showing
2 changed files
with
31 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
## Getting started | ||
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. | ||
|
||
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. | ||
|
||
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). | ||
|
||
### Getting help | ||
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). | ||
|
||
## Cloning this repository | ||
|
||
To clone using HTTPS: | ||
``` | ||
git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git | ||
``` | ||
Using SSH: | ||
``` | ||
git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git | ||
``` | ||
|
||
## Repository structure | ||
- The root of this repository contains the three files that are common to | ||
every port - list.c, queue.c and tasks.c. The kernel is contained within these | ||
three files. croutine.c implements the optional co-routine functionality - which | ||
is normally only used on very memory limited systems. | ||
|
||
- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler. | ||
See the readme file in the ```./portable``` directory for more information. | ||
|
||
- The ```./include``` directory contains the real time kernel header files. |
This file was deleted.
Oops, something went wrong.