]> git.sur5r.net Git - freertos/blobdiff - readme.txt
Move the call to traceTASK_DELETE() to before port portPRE_TASK_DELETE_HOOK() as...
[freertos] / readme.txt
index 49eecd6cd569282dd7e2acdfc28a8c9363be0213..b35e4fc9290f38bd0f0d3aa88d721be041bf3203 100644 (file)
@@ -1,19 +1,32 @@
-The download includes the kernel source code, and a demo application for EVERY\r
-RTOS port.  See http://www.freertos.org/a00017.html for full details of the \r
-directory structure and information on locating the files you require.\r
+Directories:\r
 \r
-The easiest way to use FreeRTOS is start start with one of the demo application \r
-projects.  Once this is running the project can be modified to include your own\r
-source files.  This way the correct files and compiler options will be \r
-automatically included in your application.\r
++ FreeRTOS/source contains the FreeRTOS real time kernel source code.\r
 \r
-+ The Source directory contains the real time kernel source files for every \r
-port.  The kernel itself is only 3 files.\r
++ FreeRTOS/demo contains a pre-configured demo project for every official \r
+  FreeRTOS port.\r
+  \r
++ See http://www.freertos.org/a00017.html for full details of the FreeRTOS\r
+  directory structure and information on locating the files you require.\r
 \r
-+ The Demo directory contains the demo application source files for every \r
-port.\r
+  + FreeRTOS-Plus contains additional FreeRTOS components and third party \r
+  complementary products.  THESE ARE LICENSED SEPARATELY FROM FreeRTOS although\r
+  all contain open source options.  See the license files in each respective\r
+  directory for information.\r
+  \r
++ FreeRTOS-Plus/Demo contains pre-configured demo projects for the FreeRTOS-Plus \r
+  components.  Most demo projects run in a Windows environment using the \r
+  FreeRTOS windows simulator.  These are documented on the FreeRTOS web site \r
+  http://www.FreeRTOS.org/plus\r
 \r
-+ The TraceCon directory contains the trace visualisation exe file.\r
-\r
-See the readme files in the respective directories for further information.\r
+Further readme files are contains in sub-directories as appropriate.\r
+  \r
+The easiest way to use FreeRTOS is to start with one of the pre-configured demo \r
+application projects (found in the FreeRTOS/Demo directory).  That way you will\r
+have the correct FreeRTOS source files included, and the correct include paths\r
+configured.  Once a demo application is building and executing you can remove\r
+the demo application file, and start to add in your own application source\r
+files.\r
 \r
+See also -\r
+http://www.freertos.org/FreeRTOS-quick-start-guide.html\r
+http://www.freertos.org/FAQHelp.html\r