X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=readme.txt;fp=readme.txt;h=49eecd6cd569282dd7e2acdfc28a8c9363be0213;hb=0ef7f2fd33f7f595813c31954a4896a9269691e3;hp=0000000000000000000000000000000000000000;hpb=d020a56c78be0a318aba017193df8adad5dc0b2f;p=freertos

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 000000000..49eecd6cd
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,19 @@
+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.
+
+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.
+
++ The Source directory contains the real time kernel source files for every 
+port.  The kernel itself is only 3 files.
+
++ The Demo directory contains the demo application source files for every 
+port.
+
++ The TraceCon directory contains the trace visualisation exe file.
+
+See the readme files in the respective directories for further information.
+