]> git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/readme.txt
Update libraries and sundry check-ins ready for the V10.3.0 kernel release.
[freertos] / FreeRTOS-Labs / Demo / readme.txt
1 *** INTRODUCTION ***\r
2 \r
3 This distribution currently contains demos from the FreeRTOS task pool library,\r
4 MQTT library, HTTPS Client library, Shadow library, Jobs library,\r
5 FreeRTOS+POSIX, and FreeRTOS+FAT.\r
6 \r
7 The pre-configured projects use the FreeRTOS kernel Windows port (often\r
8 called the Windows simulator) to enable their evaluation using the free Visual\r
9 Studio tools and without needing specific microcontroller hardware.\r
10 \r
11 NOTE: At this time the projects ARE A WORK IN PROGRESS and will be released in\r
12 the main FreeRTOS kernel download following full review and completion of the\r
13 documentation.\r
14 \r
15 \r
16 *** INSTRUCTIONS ***\r
17 \r
18 Instructions for configuring and using the FreeRTOS IoT libraries are in the\r
19 following links:\r
20 \r
21   + https://www.FreeRTOS.org/task-pool/\r
22   + https://www.FreeRTOS.org/mqtt/\r
23   + https://www.freertos.org/https/\r
24   + https://www.FreeRTOS.org/shadow/\r
25   + https://www.FreeRTOS.org/jobs/\r
26   + https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/\r
27   + https://freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_FAT/\r
28 \r
29 *** LOCATING THE EXAMPLE PROJECTS ***\r
30 \r
31 The Visual Studio projects for each of the FreeRTOS IoT library examples are\r
32 located in sub-directories of the following top-level directories:\r
33 \r
34   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/utilities\r
35   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt\r
36   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/https\r
37   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/shadow\r
38   + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/jobs\r
39   + /FreeRTOS-Labs/Demo/FreeRTOS_Plus_POSIX_with_actor_Windows_Simulator\r
40   + /FreeRTOS-Labs/Demo/FreeRTOS_Plus_TCP_and_FAT_Windows_Simulator\r
41 \r
42 *** ADDITIONAL INFORMATION ***\r
43 \r
44 See http://www.freertos.org/a00017.html for full details of the FreeRTOS\r
45 directory structure\r
46 \r
47 See also -\r
48 http://www.freertos.org/FreeRTOS-quick-start-guide.html\r
49 http://www.freertos.org/FAQHelp.html\r