search

pypsa-meets-earth / pypsa-earth-lit

Streamlit module that works along a stable package version
https://viz.tauritron.com/
GNU Affero General Public License v3.0
2 stars 3 forks source link

Improve README #11

Open ekatef opened 1 year ago

ekatef commented 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

  1. installing tree: sudo apt-get install tree
  2. typing tree while being with the terminal in the pypsa-earth-lit folder.

NB There are markdown extensions for vscode to also preview the docs.