Add readme files to the various FreeRTOS+ directories.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1766 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/FreeRTOS-Plus/CyaSSL/LICENSE_INFORMATION.txt b/FreeRTOS-Plus/CyaSSL/LICENSE_INFORMATION.txt
new file mode 100644 (file)
index 0000000..930f4cb
--- /dev/null
+++ b/FreeRTOS-Plus/CyaSSL/LICENSE_INFORMATION.txt
@@ -0,0 +1,7 @@
+Note the CyaSSL license terms are different to the FreeRTOS license terms.\r
+\r
+CyaSSL is dual licensed.  The files are provided here under an unmodified open\r
+source GNU GPL license.  Commercial licenses are also available.  \r
+See http://www.FreeRTOS.org/ssl\r
+\r
+\r

diff --git a/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace/readme.txt b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace/readme.txt
new file mode 100644 (file)
index 0000000..1a0cbcf
--- /dev/null
+++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace/readme.txt
@@ -0,0 +1,7 @@
+Directories:\r
+\r
++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace\r
+  contains a FreeRTOS windows simulator demo project for both FreeRTOS+CLI and\r
+  FreeRTOS+Trace.  See http://www.FreeRTOS.org/trace for information on using\r
+  the project.\r
+  \r

diff --git a/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL/readme.txt b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL/readme.txt
new file mode 100644 (file)
index 0000000..acd48a4
--- /dev/null
+++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL/readme.txt
@@ -0,0 +1,6 @@
+Directories:\r
+\r
++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL\r
+  contains a FreeRTOS windows simulator demo project for CyaSSL.  See\r
+  http://www.FreeRTOS.org/ssl for information on using the project.\r
+\r

diff --git a/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/readme.txt b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/readme.txt
new file mode 100644 (file)
index 0000000..55a8e1f
--- /dev/null
+++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/readme.txt
@@ -0,0 +1,11 @@
+Directories:\r
+\r
++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL\r
+  contains a FreeRTOS windows simulator demo project for CyaSSL.  See\r
+  http://www.FreeRTOS.org/ssl for information on using the project.\r
+\r
++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace\r
+  contains a FreeRTOS windows simulator demo project for both FreeRTOS+CLI and\r
+  FreeRTOS+Trace.  See http://www.FreeRTOS.org/trace for information on using\r
+  the project.\r
+  \r

diff --git a/FreeRTOS-Plus/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt b/FreeRTOS-Plus/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt
new file mode 100644 (file)
index 0000000..7f8fbb4
--- /dev/null
+++ b/FreeRTOS-Plus/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt
@@ -0,0 +1,9 @@
+Note the FreeRTOS+CLI license terms are different to the FreeRTOS license terms.\r
+\r
+FreeRTOS+CLI is dual licensed.  The files are provided here under an unmodified \r
+open source GNU GPL license.  Commercial licenses are also available.  \r
+See http://www.FreeRTOS.org/ssl\r
+\r
+USERS OF NXP MICROCONTROLLERS CAN OBTAIN FREE COMMERCIAL LICENSES.\r
+\r
+\r

diff --git a/FreeRTOS-Plus/FreeRTOS-Plus-IO/readme.txt b/FreeRTOS-Plus/FreeRTOS-Plus-IO/readme.txt
new file mode 100644 (file)
index 0000000..f5c8d2f
--- /dev/null
+++ b/FreeRTOS-Plus/FreeRTOS-Plus-IO/readme.txt
@@ -0,0 +1,7 @@
+It is not possible to create an example FreeRTOS+IO project for the Windows\r
+simulator.  FreeRTOS+IO information can be found on http://www.FreeRTOS.org/IO.\r
+\r
+A featured demo that includes telnet like functionality, a web server, \r
+a command line interface (using FreeRTOS+CLI) and a FAT file system is \r
+described on \r
+http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_IO/Demo_Applications/LPCXpresso_LPC1769/NXP_LPC1769_Demo_Description.shtml
\ No newline at end of file

diff --git a/FreeRTOS-Plus/FreeRTOS-Plus-Trace/readme.txt b/FreeRTOS-Plus/FreeRTOS-Plus-Trace/readme.txt
index ae47ac3f860650ec5a9ae99e26504bbef6696cf9..91a11b80cefc7800703568148b31f7521779f7b1 100644 (file)
--- a/FreeRTOS-Plus/FreeRTOS-Plus-Trace/readme.txt
+++ b/FreeRTOS-Plus/FreeRTOS-Plus-Trace/readme.txt
@@ -1,3 +1,6 @@
+THIS PRODUCT IS UNDER ACTIVE DEVELOPMENT, PLEASE SEE \r
+THE PERCEPIO WEBSITE FOR A COMPLETE LIST OF THE LATEST PORTS\r
+\r
 \r
 FreeRTOS+Trace Demo\r
 -------------------\r

diff --git a/FreeRTOS-Plus/readme.txt b/FreeRTOS-Plus/readme.txt
new file mode 100644 (file)
index 0000000..6982dfa
--- /dev/null
+++ b/FreeRTOS-Plus/readme.txt
@@ -0,0 +1,30 @@
+Directories:\r
+\r
++ FreeRTOS-Plus/CyaSSL contains the CyaSSL source files.  See \r
+  http://www.FreeRTOS.org/ssl for license information and a description of the\r
+  demo application.  The demo application is located in\r
+  FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL\r
+\r
++ FreeRTOS-Plus/FreeRTOS-Plus-CLI contains the FreeRTOS+CLI source files.  See\r
+  http://www.FreeRTOS.org/cli for license information and a description of\r
+  FreeRTOS windows simulator demo application that is located in the\r
+  FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace\r
+  directory.\r
+  \r
++ FreeRTOS-Plus/FreeRTOS-Plus-IO contains the FreeRTOS+Trace recorder code.\r
+  See http://www.FreeRTOS.org/trace for license information, links to the\r
+  Windows tool used to view recorded traces, and a description of the demo\r
+  application that is located in the \r
+  FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace\r
+  directory.\r
+  \r
++ FreeRTOS-Plus/FreeRTOS-Plus-IO contains a link to the FreeRTOS+IO source code.\r
+  Information on the FreeRTOS+IO featured demo is presented on\r
+  http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_IO/Demo_Applications/LPCXpresso_LPC1769/NXP_LPC1769_Demo_Description.shtml\r
+\r
++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator contains pre-configured\r
+  demo projects for the FreeRTOS-Plus components, as described in the bullet\r
+  points above for each component.  See http://www.FreeRTOS.org/plus\r
+\r
+Further readme files are contains in sub-directories as appropriate.\r
+  \r

diff --git a/FreeRTOS/readme.txt b/FreeRTOS/readme.txt
index a41cc4d61cc56bf6831a608827f78f89d25b5c72..13ddc515645b2e0efa65c71f5db175e29cc22de4 100644 (file)
--- a/FreeRTOS/readme.txt
+++ b/FreeRTOS/readme.txt
@@ -7,11 +7,11 @@ Directories:
 FreeRTOS port, and contains its own readme file.\r
 \r
 + See http://www.freertos.org/a00017.html for full details of the directory \r
-structure and information on locating the files you require.\r
+  structure and information on locating the files you require.\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 and included, and the correct include paths\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

diff --git a/readme.txt b/readme.txt
new file mode 100644 (file)
index 0000000..720332d
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,32 @@
+Directories:\r
+\r
++ FreeRTOS/source contains the FreeRTOS real time kernel source code.\r
+\r
++ FreeRTOS/demo contains a pre-configured demo project for every official \r
+  FreeRTOS port.\r
+  \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_Projects_Using_FreeRTOS_Simulator contains pre-configured\r
+  demo projects for the FreeRTOS-Plus components.  The demo projects run in\r
+  a Windows environment using the FreeRTOS windows simulator.  These are \r
+  documented on the FreeRTOS web site http://www.FreeRTOS.org/plus\r
+\r
++ See http://www.freertos.org/a00017.html for full details of the directory \r
+  structure and information on locating the files you require.\r
+\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