From ac1578d871590fe048994f8ffad42b13f6f07385 Mon Sep 17 00:00:00 2001 From: Abhishek Srivastava <43674998+Fabhi@users.noreply.github.com> Date: Tue, 27 Oct 2020 12:32:56 +0530 Subject: [PATCH] Updated README in FreeRTOS/FreeRTOS (#317) --- FreeRTOS/README.md | 24 ++++++++++++++++++++++++ FreeRTOS/readme.txt | 21 --------------------- 2 files changed, 24 insertions(+), 21 deletions(-) create mode 100644 FreeRTOS/README.md delete mode 100644 FreeRTOS/readme.txt diff --git a/FreeRTOS/README.md b/FreeRTOS/README.md new file mode 100644 index 0000000000..36f69f460d --- /dev/null +++ b/FreeRTOS/README.md @@ -0,0 +1,24 @@ +## Directories: + ++ The **FreeRTOS/Source** directory contains the FreeRTOS source code, and contains + its own readme file. + ++ The **FreeRTOS/Demo** directory contains a demo application for every official +FreeRTOS port, and contains its own readme file. + ++ The **FreeRTOS/Test** directory contains the tests performed on common code and the portable layer code, and contains its own readme file. + +See [FreeRTOS/SourceOrganization](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 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 - ++ [Quick Start Guide](http://www.freertos.org/FreeRTOS-quick-start-guide.html) + ++ [FAQ](http://www.freertos.org/FAQHelp.html) diff --git a/FreeRTOS/readme.txt b/FreeRTOS/readme.txt deleted file mode 100644 index 13ddc51564..0000000000 --- a/FreeRTOS/readme.txt +++ /dev/null @@ -1,21 +0,0 @@ -Directories: - -+ The FreeRTOS/Source directory contains the FreeRTOS source code, and contains - its own readme file. - -+ The FreeRTOS/Demo directory contains a demo application for every official -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. - -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