Open ekatef opened 1 year ago
Improve README from a formatting and structural perspective.
Section required: Purpose/Architecture of package (screenshot of application motivates people to reproduce/use this), Tutorial, Use with PyPSA-Earth, Contributing....
As an expamle, Osmosys applies a tree structure picture to e.g. explain the repository structure https://osemosys-global.readthedocs.io/en/latest/getting-started.html#example-1... This tree structure can be reproduced by
NB There are markdown extensions for vscode to also preview the docs.
Improve README from a formatting and structural perspective.
Section required: Purpose/Architecture of package (screenshot of application motivates people to reproduce/use this), Tutorial, Use with PyPSA-Earth, Contributing....
As an expamle, Osmosys applies a tree structure picture to e.g. explain the repository structure https://osemosys-global.readthedocs.io/en/latest/getting-started.html#example-1... This tree structure can be reproduced by
NB There are markdown extensions for vscode to also preview the docs.