Add README/documentation
This commit is contained in:
parent
1b88c22dec
commit
9583ae06cd
2 changed files with 16 additions and 0 deletions
15
doc/src/05100-lib-annotation.md
Normal file
15
doc/src/05100-lib-annotation.md
Normal file
|
@ -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.
|
||||
|
1
libimagannotation/README.md
Symbolic link
1
libimagannotation/README.md
Symbolic link
|
@ -0,0 +1 @@
|
|||
../doc/src/05100-lib-annotation.md
|
Loading…
Reference in a new issue