]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Labs/readme.txt
Add the Labs projects provided in the V10.2.1_191129 zip file.
[freertos] / FreeRTOS-Labs / readme.txt
diff --git a/FreeRTOS-Labs/readme.txt b/FreeRTOS-Labs/readme.txt
new file mode 100644 (file)
index 0000000..f22ea72
--- /dev/null
@@ -0,0 +1,53 @@
+*** IMPORTANT NOTE ***\r
+\r
+FreeRTOS-Labs contains libraries and demos that are fully functional, but\r
+undergoing optimizations or refactoring to improve memory usage, modularity,\r
+documentation, demo usability, or test coverage.  At this time the projects ARE\r
+A WORK IN PROGRESS and will be released in the main FreeRTOS directories of the\r
+download following full review and completion of the documentation.\r
+\r
+\r
+\r
+*** INTRODUCTION ***\r
+\r
+This distribution currently contains demos from the FreeRTOS task pool library,\r
+MQTT library, HTTPS Client library, Shadow library, and Jobs library.\r
+\r
+The pre-configured projects use the FreeRTOS kernel Windows port (often\r
+called the Windows simulator) to enable their evaluation using the free Visual\r
+Studio tools and without needing specific microcontroller hardware.\r
+\r
+\r
+\r
+*** INSTRUCTIONS ***\r
+\r
+Instructions for configuring and using the FreeRTOS IoT libraries are in the\r
+following links:\r
+\r
+  + https://www.FreeRTOS.org/task-pool/\r
+  + https://www.FreeRTOS.org/mqtt/\r
+  + https://www.freertos.org/https/\r
+  + https://www.FreeRTOS.org/shadow/\r
+  + https://www.FreeRTOS.org/jobs/\r
+\r
+\r
+*** LOCATING THE EXAMPLE PROJECTS ***\r
+\r
+The Visual Studio projects for each of the FreeRTOS IoT library examples are\r
+located in sub-directories of the following top-level directories:\r
+\r
+  + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/utilities\r
+  + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt\r
+  + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/https\r
+  + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/shadow\r
+  + /FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/jobs\r
+\r
+\r
+*** ADDITIONAL INFORMATION ***\r
+\r
+See http://www.freertos.org/a00017.html for full details of the FreeRTOS\r
+directory structure\r
+\r
+See also -\r
+http://www.freertos.org/FreeRTOS-quick-start-guide.html\r
+http://www.freertos.org/FAQHelp.html\r