Add readme to example directory

This commit is contained in:
AniruddhaKanhere 2024-04-14 21:56:00 -07:00
parent 6de0d7a737
commit 4fbecaa10d

9
examples/README.md Normal file
View file

@ -0,0 +1,9 @@
This directory contains rudementary examples of how to use the FreeRTOS-Kernel in isolation in different scenarios.
1. You can find how to include proper paths and files to successfully build the kernel using CMake in [cmake_example](./cmake_example/) directory.
2. Example on how to run Coverity Static Analysis on the kernel using CMake can be found in [coverity](./coverity) directory.
3. Template configuration file for the kernel (FreeRTOSConfig.h) can be found in [template_configuration](./template_configuration) directory.
You can find examples of how to use FreeRTOS-Kernel on different microcontrollers [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS/Demo).
Additional examples of the kernel being used in real life applications in tandem with many other libraries (i.e. FreeRTOS+TCP, coreMQTT, coreHTTP etc.) [here](https://github.com/FreeRTOS/FreeRTOS/tree/main/FreeRTOS-Plus/Demo).