README file with instructions for installation and examples of common use
Some random interested person should be able to follow the instructions of the README file, and then:
- Successfully install the project
- Starting from a computer with just vanilla Python, and nothing else
- Also we can give special simple instruction for those using PyCharm
- Run some simple examples and have an idea of how to do what they want with the software
- Have an overview of the meaning of the most important options/parameters
- With some examples
We can use the contents of inputs.yaml
as a basis for this.
A nice benefit is that the README
file is shown as the landing page when you open the project on Gitlab, so interested people will immediately see these instructions