summaryrefslogtreecommitdiff
path: root/source/application/api/use_case/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'source/application/api/use_case/readme.md')
-rw-r--r--source/application/api/use_case/readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/source/application/api/use_case/readme.md b/source/application/api/use_case/readme.md
new file mode 100644
index 0000000..f7eb0d1
--- /dev/null
+++ b/source/application/api/use_case/readme.md
@@ -0,0 +1,11 @@
+## Use case APIs
+
+The directories in here are individual CMake projects to generate use case API static libraries. These libraries are
+intended to be used by external projects that only want access to the ready-to-use ML use case pipelines implemented in this repository.
+This can be as CMake projects, but also in the form of CMSIS-packs. These libraries do not depend on the HAL layer and
+are platform-agnostic to allow for easy portability.
+
+## Useful links
+
+* [Repository Structure](../../../../docs/documentation.md#repository-structure)
+* [Reusable Software](../../../../Readme.md#reusable-software).