Tweak the README for readability #206
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
The README is the introduction to the project for most people, but there were a few parts of it which were hard to read, assumed prior knowledge of the project or its history, or going into unnecessary detail. This commit tries to fix this and updates the README.
mtreinish
force-pushed
the
rework-readme-overview
branch
from
27e1532
to
7fc28c6
Compare
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.
The README is the introduction to the project for most people, but there
were a few parts of it which were hard to read, assumed prior knowledge
of the project or its history, or going into unnecessary detail. This
commit tries to fix this and updates the README.