FreeRTOS-Kernel/FreeRTOS/README.md
alfred gedeon ae92d8c6ee
Add uncrustify github workflow (#659)
* Add uncrustify github workflow

* Fix exclusion pattern

* fix find expression

* exclude uncrustify files

* Uncrustify common demo and test files

* exlude white space checking files

* Fix EOL whitespace checker

* Remove whitespaces from EOL

* Fix space at EOL

* Fix find spaces at EOL

Co-authored-by: Archit Aggarwal <architag@amazon.com>
2021-07-22 14:23:48 -07:00

24 lines
1.1 KiB
Markdown

## Directories:
+ The **FreeRTOS/Source** directory contains the FreeRTOS source code, and contains
its own readme file.
+ The **FreeRTOS/Demo** directory contains a demo application for every official
FreeRTOS port, and contains its own readme file.
+ The **FreeRTOS/Test** directory contains the tests performed on common code and the portable layer code, and contains its own readme file.
See [FreeRTOS/SourceOrganization](http://www.freertos.org/a00017.html) for full details of the directory structure and information on locating the files you require.
The easiest way to use FreeRTOS is to start with one of the pre-configured demo
application projects (found in the FreeRTOS/Demo directory). 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 file, and start to add in your own application source
files.
### See also -
+ [Quick Start Guide](http://www.freertos.org/FreeRTOS-quick-start-guide.html)
+ [FAQ](http://www.freertos.org/FAQHelp.html)