summaryrefslogtreecommitdiff
path: root/lib/freertos-posix/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/freertos-posix/README.md')
-rw-r--r--lib/freertos-posix/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/freertos-posix/README.md b/lib/freertos-posix/README.md
new file mode 100644
index 0000000..d01fca3
--- /dev/null
+++ b/lib/freertos-posix/README.md
@@ -0,0 +1,15 @@
+## FreeRTOS+POSIX: Portable Operating System Interface (POSIX threading wrapper) for FreeRTOS
+
+The Portable Operating System Interface (POSIX) is a family of standards specified by the IEEE Computer Society for maintaining compatibility between operating systems. FreeRTOS+POSIX implements a subset of the [POSIX threading](https://pubs.opengroup.org/onlinepubs/7908799/xsh/threads.html) API.
+
+With FreeRTOS+POSIX, an existing POSIX threading compliant application can be ported to run on the FreeRTOS kernel, and therefor leverage all the [Amazon FreeRTOS](https://www.freertos.org/FAQ_Amazon.html) functionality. Additionally, a library designed for use with POSIX threading compatible operating systems can be ported to FreeRTOS kernel based applications.
+
+For more on FreeRTOS+POSIX, please visit [freertos.org](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/index.html)
+
+This repository only contains source code. For demo applications, please visit https://github.com/FreeRTOS/FreeRTOS-Labs.
+
+## To consume FreeRTOS+POSIX
+It is recommended to use this repository as a submodule. Please refer to [Git Tools — Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
+
+## Notes
+This project is undergoing optimizations or refactorization to improve memory usage, modularity, documentation, demo usability, or test coverage.