]> git.sur5r.net Git - freertos/blob - readme.txt
Add readme files to the various FreeRTOS+ directories.
[freertos] / readme.txt
1 Directories:\r
2 \r
3 + FreeRTOS/source contains the FreeRTOS real time kernel source code.\r
4 \r
5 + FreeRTOS/demo contains a pre-configured demo project for every official \r
6   FreeRTOS port.\r
7   \r
8 + FreeRTOS-Plus contains additional FreeRTOS components and third party \r
9   complementary products.  THESE ARE LICENSED SEPARATELY FROM FreeRTOS although\r
10   all contain open source options.  See the license files in each respective\r
11   directory for information.\r
12   \r
13 + FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator contains pre-configured\r
14   demo projects for the FreeRTOS-Plus components.  The demo projects run in\r
15   a Windows environment using the FreeRTOS windows simulator.  These are \r
16   documented on the FreeRTOS web site http://www.FreeRTOS.org/plus\r
17 \r
18 + See http://www.freertos.org/a00017.html for full details of the directory \r
19   structure and information on locating the files you require.\r
20 \r
21 Further readme files are contains in sub-directories as appropriate.\r
22   \r
23 The easiest way to use FreeRTOS is to start with one of the pre-configured demo \r
24 application projects (found in the FreeRTOS/Demo directory).  That way you will\r
25 have the correct FreeRTOS source files included, and the correct include paths\r
26 configured.  Once a demo application is building and executing you can remove\r
27 the demo application file, and start to add in your own application source\r
28 files.\r
29 \r
30 See also -\r
31 http://www.freertos.org/FreeRTOS-quick-start-guide.html\r
32 http://www.freertos.org/FAQHelp.html\r