summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Julicher <jjulicher@mac.com>2023-04-11 11:52:56 -0700
committerGitHub <noreply@github.com>2023-04-11 11:52:56 -0700
commit1309654d6f5d1342b4a9d3d7ae0824e8fcaefaf2 (patch)
tree6d95fe580646a9f12b9cc2f37bd1e9c4d72fbad7
parentd57e2b746b6ae086719d8e68f12f3665c08a0452 (diff)
downloadfreertos-git-1309654d6f5d1342b4a9d3d7ae0824e8fcaefaf2.tar.gz
Added a link to the community supported demos repo in the demos readme.txt (#987)
* Added a link to the community supported demos repo in the demos readme.txt * Update FreeRTOS/Demo/readme.txt Co-authored-by: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com> * Update and rename readme.txt to readme.md --------- Co-authored-by: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com>
-rw-r--r--FreeRTOS/Demo/readme.md (renamed from FreeRTOS/Demo/readme.txt)9
1 files changed, 8 insertions, 1 deletions
diff --git a/FreeRTOS/Demo/readme.txt b/FreeRTOS/Demo/readme.md
index 8a744ffd6..316ae5699 100644
--- a/FreeRTOS/Demo/readme.txt
+++ b/FreeRTOS/Demo/readme.md
@@ -1,3 +1,4 @@
+# Documentation
Links to a documentation page for each demo are provided on the following
URL: http://www.freertos.org/a00090.html
@@ -11,9 +12,15 @@ every port.
+ All the other directories contain a project or makefile for the demo
application targeted at a particular microcontroller.
-
For example, if you are interested in the ATMega323 demo application for
the WinAVR tools then the AVR_ATMega323_WinAVR directory contains the
relevant makefile. The makefile includes files from the Demo/ATMega323
and the Demo/Common directories. If this is the only port you are
interested in then all the other directories can be ignored.
+
+# Community Supported Demos
+Not all demos are maintained by the FreeRTOS team in the FreeRTOS/FreeRTOS repo.
+Community Supported Demos can be found here:
+https://github.com/FreeRTOS/FreeRTOS-Community-Supported-Demos
+
+If you would like to contribute by adding a demo, please see this guide to get to know the prerequisites and to get information on how to structure the directories: https://github.com/FreeRTOS/FreeRTOS/blob/main/FreeRTOS/Demo/ThirdParty/Template/README.md