X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=readme.txt;h=b35e4fc9290f38bd0f0d3aa88d721be041bf3203;hb=059d65bb93ebd642f835a72c322b93f947ce64ab;hp=49eecd6cd569282dd7e2acdfc28a8c9363be0213;hpb=0ef7f2fd33f7f595813c31954a4896a9269691e3;p=freertos diff --git a/readme.txt b/readme.txt index 49eecd6cd..b35e4fc92 100644 --- a/readme.txt +++ b/readme.txt @@ -1,19 +1,32 @@ -The download includes the kernel source code, and a demo application for EVERY -RTOS port. See http://www.freertos.org/a00017.html for full details of the -directory structure and information on locating the files you require. +Directories: -The easiest way to use FreeRTOS is start start with one of the demo application -projects. Once this is running the project can be modified to include your own -source files. This way the correct files and compiler options will be -automatically included in your application. ++ FreeRTOS/source contains the FreeRTOS real time kernel source code. -+ The Source directory contains the real time kernel source files for every -port. The kernel itself is only 3 files. ++ FreeRTOS/demo contains a pre-configured demo project for every official + FreeRTOS port. + ++ See http://www.freertos.org/a00017.html for full details of the FreeRTOS + directory structure and information on locating the files you require. -+ The Demo directory contains the demo application source files for every -port. + + FreeRTOS-Plus contains additional FreeRTOS components and third party + complementary products. THESE ARE LICENSED SEPARATELY FROM FreeRTOS although + all contain open source options. See the license files in each respective + directory for information. + ++ FreeRTOS-Plus/Demo contains pre-configured demo projects for the FreeRTOS-Plus + components. Most demo projects run in a Windows environment using the + FreeRTOS windows simulator. These are documented on the FreeRTOS web site + http://www.FreeRTOS.org/plus -+ The TraceCon directory contains the trace visualisation exe file. - -See the readme files in the respective directories for further information. +Further readme files are contains in sub-directories as appropriate. + +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 - +http://www.freertos.org/FreeRTOS-quick-start-guide.html +http://www.freertos.org/FAQHelp.html