Example Portfolio Application issueshttps://collaborating.tuhh.de/e-10/teaching/mathematical-image-processing/example-portfolio-application/-/issues2022-02-10T11:17:09+01:00https://collaborating.tuhh.de/e-10/teaching/mathematical-image-processing/example-portfolio-application/-/issues/11Documentation2022-02-10T11:17:09+01:00Fabian Nuraddin Alexander Gabelfabian.gabel@tuhh.deDocumentation# Comments and README
- [x] Rewrite `README.md`
- [x] Comment the routines
- [x] Comment the .gitlab-ci.yml files
- [x] Comment the TeX template if necessary
- [x] Add "LABEL"s to the Dockerfile (Author/Maintainer, Usage, Version etc. w...# Comments and README
- [x] Rewrite `README.md`
- [x] Comment the routines
- [x] Comment the .gitlab-ci.yml files
- [x] Comment the TeX template if necessary
- [x] Add "LABEL"s to the Dockerfile (Author/Maintainer, Usage, Version etc. whatever seems suitable)
- [x] 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
- [x] Document the use cases in the project wiki
- [x] 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](https://github.com/phw/peek)) or a screencast. Maybe resolve https://collaborating.tuhh.de/cqp7011/mathbildprojektjj/-/issues/13 firstJoscha JanssenJoscha Janssen