summaryrefslogtreecommitdiff
path: root/source/application/api/use_case
diff options
context:
space:
mode:
authorKshitij Sisodia <kshitij.sisodia@arm.com>2022-08-18 12:54:34 +0100
committerNina Drozd <nina.drozd@arm.com>2022-08-25 14:32:02 +0000
commitc9f1717d227e21ebfab72cceee90b1f8f8522867 (patch)
tree991e1cb1b921f4cbe6cc88edc1797eb0eafba4cc /source/application/api/use_case
parent271c69e8e364361f3e4c839a10a4f29ef4c9c866 (diff)
downloadml-embedded-evaluation-kit-c9f1717d227e21ebfab72cceee90b1f8f8522867.tar.gz
MLECO-3252: Minor documentation additions
Documentation md files added under source tree with links to the main docs. Minor updates to FAQs for MLECO-3251 as well. Change-Id: Ifdcc587f2fcf77228fd46e211d3f9c3963bc9b97 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'source/application/api/use_case')
-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).