Essential running documentation missing

[hoijui]

In GitLab by @julianstirling on Feb 25, 2022, 17:20

Running documentation is missing. I can run -h but there is little information on what I am expecting each sub-command to do, or even any context for what the entire program aims to do.

[hoijui]

hey julian!
I am on the issues now; thank you very much for all of them! :-)

[hoijui]

mentioned in commit a1d0b3d

[hoijui]

Finally got around to work on this and your other issues now (was side-tracked for 2 months).
Could you maybe have an other look, @julianstirling?

here:
https://gitlab.com/OSEGermany/osh-tool/-/commit/a1d0b3d418a90cc4d5f39a3d63597a9d27bba010

I bet it is still unclear, but I (and my supervisor Pieter) are too into it to see it. I also find it hard to explain it in a way that does not consist of ... 10 complex words mashed together, knowing that most peoples brain would turn of after 5 words (mine included).

[hoijui]

In GitLab by @julianstirling on May 18, 2022, 13:00

Thanks @hoijui, it is much clearer. Documentation is never easy to get perfect, but this at least gives enough information for a new user to understand what to do and why the program does what it does.

Happy for you to close this. Thanks for also looking at the other issues.

I have opened a merge request (!1) as I found some typos.