Skip to content

User docs improvements ideas

  • State the minimum Python version in the README (cf. #208)
  • State the operating system under which the script is supposed to work => the Makefile can only be used with a bash. Alternative way? (cf. #209)
  • If you support both pip and pipenv, please provide running instructions without pipenv as well. Maybe poetry would be a better fit?
  • Please provide a working example including the expected results (images etc.). In addition, one could check the example in the CI build as well. (cf. #210)
Edited by Hueser, Christian
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information