Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #11

Open
ekatef opened this issue Aug 7, 2023 · 0 comments
Open

Improve README #11

ekatef opened this issue Aug 7, 2023 · 0 comments

Comments

@ekatef
Copy link
Member

ekatef commented Aug 7, 2023

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ekatef