Touch up the README #92
Merged
Conversation
This file contains 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
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.
Touch up the README
Description
For a better user experience, this PR rewords the README to be more cohesive throughout and removes components that are no longer necessary, such as the table of contents (since the document is now quite short) and the development environment set up instructions (which have been moved to the Contributing Guidelines page in the Wiki). Please note that the included example output reflects the changes proposed in PR #91. @laurennevill, I've added you as a reviewer since you were the main contributor to the README, but please feel free to review only if you are available and interested!
Type of Change
Contributors
Reminder