Documentation
Comments and README
-
Rewrite README.md
-
Comment the routines -
Comment the .gitlab-ci.yml files -
Comment the TeX template if necessary -
Add "LABEL"s to the Dockerfile (Author/Maintainer, Usage, Version etc. whatever seems suitable) -
Add Screenshots of the demo.pdf (maybe even upload a demo.pdf) to the wiki -
Document unit tests
The amount of comments should be reasonable.
User Documentation, Installation, Use cases
-
Document the use cases in the project wiki -
Describe the "Installation" of the project in the project wiki, i.e. what do I need to do in order to set it up properly in my own project). You can use Screenshots, gifs (with peek) or a screencast. Maybe resolve https://collaborating.tuhh.de/cqp7011/mathbildprojektjj/-/issues/13 first
Edited by Fabian Nuraddin Alexander Gabel