-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add readme to example directory #1032
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+17
−0
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
4fbecaa
Add readme to example directory
AniruddhaKanhere 9a49a86
Add readme to example directory
AniruddhaKanhere 1ee2a89
Add readme to example directory
AniruddhaKanhere fe58833
Add readme to example directory
AniruddhaKanhere caed9d8
remove whitespace
AniruddhaKanhere da33a83
Update wording
AniruddhaKanhere 6541a7c
Update examples/README.md
AniruddhaKanhere ced4861
Add Coverity webpage link
AniruddhaKanhere File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,17 @@ | ||
# README for FreeRTOS-Kernel/examples | ||
|
||
The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects. | ||
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. | ||
This directory aims to further facilitate the beginners in building their first FreeRTOS project. | ||
|
||
|
||
## Directory Structure: | ||
|
||
* 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. | ||
* 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. | ||
AniruddhaKanhere marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* The [template_configuration](./template_configuration) directory contains a sample configuration file FreeRTOSConfig.h which helps you in preparing your application configuration | ||
|
||
|
||
## Additional examples | ||
|
||
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). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.