From 1309654d6f5d1342b4a9d3d7ae0824e8fcaefaf2 Mon Sep 17 00:00:00 2001 From: Joseph Julicher Date: Tue, 11 Apr 2023 11:52:56 -0700 Subject: [PATCH] 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> --- FreeRTOS/Demo/{readme.txt => readme.md} | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) rename FreeRTOS/Demo/{readme.txt => readme.md} (63%) diff --git a/FreeRTOS/Demo/readme.txt b/FreeRTOS/Demo/readme.md similarity index 63% rename from FreeRTOS/Demo/readme.txt rename to 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