Skip to content

Commit da33a83

Browse files
Update wording
1 parent caed9d8 commit da33a83

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

examples/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
# Examples of using the FreeRTOS-Kernel in isolation
1+
# README for FreeRTOS-Kernel/examples
22

3-
1. You can find how to include proper paths and files to successfully build the kernel using CMake in [cmake_example](./cmake_example/) directory.
4-
2. Example on how to run Coverity Static Analysis on the kernel using CMake can be found in [coverity](./coverity) directory.
5-
3. Template configuration file for the kernel (FreeRTOSConfig.h) can be found in [template_configuration](./template_configuration) directory.
3+
The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects.
4+
See [FreeRTOS/FreeRTOS/Demo](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS/Demo) to find a list of pre-configured demos on multiple platforms which demonstrate the working of the FreeRTOS-Kernel.
5+
This directory aims to further facilitate the beginners in building their first FreeRTOS project.
66

77

8-
### Additional examples
8+
## Directory Structure:
99

10-
You can find examples of how to use FreeRTOS-Kernel on different microcontrollers [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS/Demo).
10+
* The [cmake_example](./cmake_example) directory contains a minimal freertos example project , which uses the configuration file in the template_configuration directory listed below. This will provide you a starting point for building you applications using FreeRTOS-Kernel.
11+
* The [coverity](./coverity) directory contains a project to run Synopsys Coverity for checking MISRA compliance. This directory contains further readme files and links to documentation.
12+
* The [template_configuration](./template_configuration) directory contains a sample configuration file FreeRTOSConfig.h which helps you in preparing your application configuration
13+
14+
15+
## Additional examples
1116

1217
Additional examples of the kernel being used in real life applications in tandem with many other libraries (i.e. FreeRTOS+TCP, coreMQTT, coreHTTP etc.) can be found [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo).

0 commit comments

Comments
 (0)