From: richardbarry Date: Sat, 11 Aug 2012 22:57:53 +0000 (+0000) Subject: Add readme files to the various FreeRTOS+ directories. X-Git-Tag: V7.2.0~6 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=f2cb6a6743319cf75c09f243802190da6ba76dc6;p=freertos 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 index 000000000..930f4cb19 --- /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. + +CyaSSL is dual licensed. The files are provided here under an unmodified open +source GNU GPL license. Commercial licenses are also available. +See http://www.FreeRTOS.org/ssl + + 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 index 000000000..1a0cbcfe0 --- /dev/null +++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace/readme.txt @@ -0,0 +1,7 @@ +Directories: + ++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace + contains a FreeRTOS windows simulator demo project for both FreeRTOS+CLI and + FreeRTOS+Trace. See http://www.FreeRTOS.org/trace for information on using + the project. + 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 index 000000000..acd48a490 --- /dev/null +++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL/readme.txt @@ -0,0 +1,6 @@ +Directories: + ++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL + contains a FreeRTOS windows simulator demo project for CyaSSL. See + http://www.FreeRTOS.org/ssl for information on using the project. + 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 index 000000000..55a8e1f2b --- /dev/null +++ b/FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/readme.txt @@ -0,0 +1,11 @@ +Directories: + ++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL + contains a FreeRTOS windows simulator demo project for CyaSSL. See + http://www.FreeRTOS.org/ssl for information on using the project. + ++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace + contains a FreeRTOS windows simulator demo project for both FreeRTOS+CLI and + FreeRTOS+Trace. See http://www.FreeRTOS.org/trace for information on using + the project. + diff --git a/FreeRTOS-Plus/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt b/FreeRTOS-Plus/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt new file mode 100644 index 000000000..7f8fbb448 --- /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. + +FreeRTOS+CLI is dual licensed. The files are provided here under an unmodified +open source GNU GPL license. Commercial licenses are also available. +See http://www.FreeRTOS.org/ssl + +USERS OF NXP MICROCONTROLLERS CAN OBTAIN FREE COMMERCIAL LICENSES. + + diff --git a/FreeRTOS-Plus/FreeRTOS-Plus-IO/readme.txt b/FreeRTOS-Plus/FreeRTOS-Plus-IO/readme.txt new file mode 100644 index 000000000..f5c8d2ff8 --- /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 +simulator. FreeRTOS+IO information can be found on http://www.FreeRTOS.org/IO. + +A featured demo that includes telnet like functionality, a web server, +a command line interface (using FreeRTOS+CLI) and a FAT file system is +described on +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 ae47ac3f8..91a11b80c 100644 --- 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 +THE PERCEPIO WEBSITE FOR A COMPLETE LIST OF THE LATEST PORTS + FreeRTOS+Trace Demo ------------------- diff --git a/FreeRTOS-Plus/readme.txt b/FreeRTOS-Plus/readme.txt new file mode 100644 index 000000000..6982dfa6d --- /dev/null +++ b/FreeRTOS-Plus/readme.txt @@ -0,0 +1,30 @@ +Directories: + ++ FreeRTOS-Plus/CyaSSL contains the CyaSSL source files. See + http://www.FreeRTOS.org/ssl for license information and a description of the + demo application. The demo application is located in + FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CyaSSL + ++ FreeRTOS-Plus/FreeRTOS-Plus-CLI contains the FreeRTOS+CLI source files. See + http://www.FreeRTOS.org/cli for license information and a description of + FreeRTOS windows simulator demo application that is located in the + FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace + directory. + ++ FreeRTOS-Plus/FreeRTOS-Plus-IO contains the FreeRTOS+Trace recorder code. + See http://www.FreeRTOS.org/trace for license information, links to the + Windows tool used to view recorded traces, and a description of the demo + application that is located in the + FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator/FreeRTOS_Plus_CLI_with_Trace + directory. + ++ FreeRTOS-Plus/FreeRTOS-Plus-IO contains a link to the FreeRTOS+IO source code. + Information on the FreeRTOS+IO featured demo is presented on + http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_IO/Demo_Applications/LPCXpresso_LPC1769/NXP_LPC1769_Demo_Description.shtml + ++ FreeRTOS-Plus/Demo_Projects_Using_FreeRTOS_Simulator contains pre-configured + demo projects for the FreeRTOS-Plus components, as described in the bullet + points above for each component. See http://www.FreeRTOS.org/plus + +Further readme files are contains in sub-directories as appropriate. + diff --git a/FreeRTOS/readme.txt b/FreeRTOS/readme.txt index a41cc4d61..13ddc5156 100644 --- a/FreeRTOS/readme.txt +++ b/FreeRTOS/readme.txt @@ -7,11 +7,11 @@ Directories: FreeRTOS port, and contains its own readme file. + See http://www.freertos.org/a00017.html for full details of the directory -structure and information on locating the files you require. + structure and information on locating the files you require. 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 and included, and the correct include paths +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. 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