From 1a4abbc9e91b13fd6394464ade59d5e048320c7c Mon Sep 17 00:00:00 2001 From: Yuhui Zheng <10982575+yuhui-zheng@users.noreply.github.com> Date: Tue, 17 Mar 2020 19:30:02 -0700 Subject: [PATCH] Maintenance -- clean up readme.txt and add url to GitHub. (#38) * Removing readme.txt, as now we have README.md in place. The only information missing from README.md is about FAQ. * Adding FAQ information in README.md. * Adding a .url to root to redict user to FreeRTOS github home page. --- GitHub-FreeRTOS-Home.url | 8 ++++++++ README.md | 2 +- readme.txt | 32 -------------------------------- 3 files changed, 9 insertions(+), 33 deletions(-) create mode 100644 GitHub-FreeRTOS-Home.url delete mode 100644 readme.txt diff --git a/GitHub-FreeRTOS-Home.url b/GitHub-FreeRTOS-Home.url new file mode 100644 index 0000000000..3daafe2934 --- /dev/null +++ b/GitHub-FreeRTOS-Home.url @@ -0,0 +1,8 @@ +[{000214A0-0000-0000-C000-000000000046}] +Prop3=19,2 +[InternetShortcut] +URL=https://github.com/FreeRTOS/FreeRTOS +IconIndex=0 +IDList= +HotKey=0 + diff --git a/README.md b/README.md index dddb3a49b2..56d13c2141 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The easiest way to use FreeRTOS is to start with one of the pre-configured demo Additionally, for FreeRTOS kernel feature information refer to the [Developer Documentation](https://www.freertos.org/features.html), and [API Reference](https://www.freertos.org/a00106.html). ### Getting help -If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). +If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the [FreeRTOS Community Support Forum](https://forums.freertos.org). Please also refer to [FAQ](http://www.freertos.org/FAQHelp.html) for frequently asked questions. ## Cloning this repository This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components. diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 1f7dbf836a..0000000000 --- a/readme.txt +++ /dev/null @@ -1,32 +0,0 @@ -Directories: - -+ FreeRTOS/source contains the FreeRTOS real time kernel source code. - -+ FreeRTOS/demo contains a pre-configured demo project for every official - FreeRTOS port. - -+ See http://www.freertos.org/a00017.html for full details of the FreeRTOS - directory structure and information on locating the files you require. - - + 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 contains pre-configured demo projects for the FreeRTOS-Plus - components. Most 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 - -Further readme files are contained 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