summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
authorrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>2012-08-11 22:57:53 +0000
committerrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>2012-08-11 22:57:53 +0000
commit344a09b89194191eb3938e1ab023e3b7044dc816 (patch)
tree09667785a7d96cc7be481926302470c9319fdc2c /readme.txt
parentf279ebee719fa6bda3f91061819e6b42051c7395 (diff)
downloadfreertos-344a09b89194191eb3938e1ab023e3b7044dc816.tar.gz
Add readme files to the various FreeRTOS+ directories.
git-svn-id: http://svn.code.sf.net/p/freertos/code/trunk@1766 1d2547de-c912-0410-9cb9-b8ca96c0e9e2
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 000000000..720332d5a
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,32 @@
+Directories:
+
++ FreeRTOS/source contains the FreeRTOS real time kernel source code.
+
++ FreeRTOS/demo contains a pre-configured demo project for every official
+ FreeRTOS 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_Projects_Using_FreeRTOS_Simulator contains pre-configured
+ demo projects for the FreeRTOS-Plus components. The 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
+
++ See http://www.freertos.org/a00017.html for full details of the directory
+ structure and information on locating the files you require.
+
+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