create user manual

[fgardt]

In GitLab by @Merseleo on Mar 27, 2023, 17:04

Documantation description

For the submission of the entire project we should provide a users manual. Currently some information how the library or app can be used can be find in the READMEs. But we should also provide a general document, containing all further information, displaying examples and hints and links to the READMEs or the Wiki. Therefor

• [ ] create a "user manual" document
• [ ] add a section about the library, containing
  • [ ] installation (or link to it)
  • [ ] features
  • [ ] API methods and description
  • [ ] examples
• [ ] add a section about the demo app, containing
  • [ ] purpose
  • [ ] general structure
  • [ ] all links
  • [ ] feature and possible tasks + solutions
  • [ ] information, how library was used
  • [ ] examples and walkthrough

Hint: The tasks should be reviewed and checked against the need of a possible user

/cc @Slartibartfass2

[fgardt]

In GitLab by @mm1398 on May 19, 2023, 15:20

created branch docs/42-create-user-manual to address this issue

[fgardt]

In GitLab by @Merseleo on May 22, 2023, 03:32

mentioned in commit 0447ca44d4f35c7918020817cdd67fac91365154