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

add docs? #86

Closed
mathause opened this issue Mar 26, 2024 · 2 comments · Fixed by #134
Closed

add docs? #86

mathause opened this issue Mar 26, 2024 · 2 comments · Fixed by #134

Comments

@mathause
Copy link
Collaborator

Could somewhat reorganize the docs:

  • move the current "docs" from the README to a separate file
  • add minimal installation instructions see e.g. mplotutils
  • from README.md add links to
    • installation
    • usage docs
    • changelog
@mathause
Copy link
Collaborator Author

@veni-vidi-vici-dormivi do you want to give this a shot? Will probably take you a day, though. The whole thing is slightly more complicated because we may mix rst & markdown. Some resources:

@veni-vidi-vici-dormivi
Copy link
Collaborator

I'll give it a try :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants