Skip to content

Commit 1ed681c

Browse files
Add readme to example directory (#1032)
* Add readme to example directory * Add readme to example directory * Add readme to example directory * Add readme to example directory * remove whitespace * Update wording * Update examples/README.md Co-authored-by: chinglee-iot <61685396+chinglee-iot@users.noreply.github.com> * Add Coverity webpage link --------- Co-authored-by: chinglee-iot <61685396+chinglee-iot@users.noreply.github.com>
1 parent 6de0d7a commit 1ed681c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

examples/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# README for FreeRTOS-Kernel/examples
2+
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.
6+
7+
8+
## Directory Structure:
9+
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 with a starting point for building your applications using FreeRTOS-Kernel.
11+
* The [coverity](./coverity) directory contains a project to run [Synopsys Coverity](https://www.synopsys.com/software-integrity/static-analysis-tools-sast/coverity.html) 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
16+
17+
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)