Skip to content

Commit 08c9c91

Browse files
authored
Replacing readme.txt with README.md. (#11)
1 parent 10bbbcf commit 08c9c91

File tree

2 files changed

+31
-17
lines changed

2 files changed

+31
-17
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Getting started
2+
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.
3+
4+
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.
5+
6+
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).
7+
8+
### Getting help
9+
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).
10+
11+
## Cloning this repository
12+
13+
To clone using HTTPS:
14+
```
15+
git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git
16+
```
17+
Using SSH:
18+
```
19+
git clone [email protected]:FreeRTOS/FreeRTOS-Kernel.git
20+
```
21+
22+
## Repository structure
23+
- The root of this repository contains the three files that are common to
24+
every port - list.c, queue.c and tasks.c. The kernel is contained within these
25+
three files. croutine.c implements the optional co-routine functionality - which
26+
is normally only used on very memory limited systems.
27+
28+
- The ```./portable``` directory contains the files that are specific to a particular microcontroller and/or compiler.
29+
See the readme file in the ```./portable``` directory for more information.
30+
31+
- The ```./include``` directory contains the real time kernel header files.

readme.txt

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)