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.

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

Refactor README.md for better visibility + readablilty for new users #463

Open
gokulprathin8 opened this issue Mar 5, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed Markdown Readme

Comments

@gokulprathin8
Copy link
Collaborator

What is this PR about?

Since we do not have a full fledged website for geoweaver docs. We have to utilize README.md to full extend to convey and convice users to try out / use geoweaver for their research / project.

There is a detailed outline describing what needs to go into the new README.md
https://docs.google.com/document/d/1ATng4rOhrOTIGIEGprWgKy7MAbm0yz_AGkmtCDhPEZ8/edit?usp=sharing

Important Links:
Website to write a README with all important side headings included - https://readme.so/
README badges and icons - https://github.com/Ileriayo/markdown-badges

What needs to be done?

  • Changes to include all badges, we need new badges: binder, planetary computer, Downloads
  • Circle CI needs to be repalce with Github Actions
  • Geoweaver should include a link pointing to Pygeoweaver encoraging people with python background to check that repo
  • Geoweaver README.md should highlight the new website - https://geoweaver.dev/
  • Readme should have a bigger logo at the start of the readme similar to popular library readme files like xarray or matplotlib
  • We have to use as many GIFs as possible to make the README look interactive
  • Include citations and links previous papers based on geoweaver
  • Clearly state why geoweaver exists - usecases, examples and demos
  • Clear installation instructions for each platform: Widnows, Linux and MacOS. Pleas refer to https://geoweaver.dev/blog/installation/ for more details
  • At the very end we should show all the contributors names, this should be dynamic. There are many projects that do this and we can re-use their README or understand how to make it dynamic.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed Markdown Readme
Projects
None yet
Development

No branches or pull requests

3 participants