Update Readme with an introduction and documentation, installation and contribution sections#199
Merged
Update Readme with an introduction and documentation, installation and contribution sections#199
Conversation
…d contribution sections Update Readme with an introduction and sections describing the documentation, installation instructions and how to contribute. Also removes the Releasing part, since that's now covered in the maintainers section of CONTRIBUTING.md.
3 tasks
quaquel
approved these changes
Oct 25, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update Readme with an introduction and sections describing the documentation, installation instructions and how to contribute.
Also removes the Releasing part, since that's now covered in the maintainers section of CONTRIBUTING.md.
@quaquel Please check how (and if) you want to be mentioned in the Readme. I found it difficult to word.
We might also want to include something about citation (#198) and open the Discussions tab (#198).
Closes #158.