From 9583ae06cdc2f6ab9286814ec08bf3786c0c572c Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Mon, 26 Jun 2017 19:23:19 +0200 Subject: [PATCH] Add README/documentation --- doc/src/05100-lib-annotation.md | 15 +++++++++++++++ libimagannotation/README.md | 1 + 2 files changed, 16 insertions(+) create mode 100644 doc/src/05100-lib-annotation.md create mode 120000 libimagannotation/README.md diff --git a/doc/src/05100-lib-annotation.md b/doc/src/05100-lib-annotation.md new file mode 100644 index 00000000..a40842cc --- /dev/null +++ b/doc/src/05100-lib-annotation.md @@ -0,0 +1,15 @@ +## libimagannotation + +This library provides annotation functionality for entries. + +Annotations are normal Store entries, but their header at +`annotation.is_annotation` is set to `true`. + +Annotations are linked to an entry (as in `libimagentrylink`). + +### Library functionality + +The library features two traits: One to extend an `Entry` with annotation +functionality and another one for extending the `Store` with functionality to +get annotations of an entry and all annotations in the store. + diff --git a/libimagannotation/README.md b/libimagannotation/README.md new file mode 120000 index 00000000..5c4afa4a --- /dev/null +++ b/libimagannotation/README.md @@ -0,0 +1 @@ +../doc/src/05100-lib-annotation.md \ No newline at end of file