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 #62

Open

alexandertornede opened this issue Jun 28, 2023 · 1 comment

Labels

Contributor

alexandertornede commented Jun 28, 2023

We would like to improve the README:

Add visualization GIFs
Add a very minimal example at the top
Add very simple installation guide at the top

As part of this, we can also look into similar repos and what makes their READMEs great such that we can benefit from their ideas.

sarah-segel added the documentation label

sarah-segel added this to the v2.0 milestone

Collaborator

sarah-segel commented Aug 21, 2024 •

edited

Loading

Partly addressed in #181, but could still be improved & GIF/video (#115) is still missing.

sarah-segel removed this from the v2.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment