Readme: Restructure and clarify requirements #93
Merged
Conversation
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
euanh
force-pushed
the
docs/project-readme
branch
7 times, most recently
from
d09b536 to
54dda21
Compare
euanh
force-pushed
the
docs/project-readme
branch
from
54dda21 to
31b1f0c
Compare
euanh
changed the title
euanh
added
area/documentation
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.
Motivation
README.md is the first file new users see when they visit the repository. It should be well-structured, so information is easy to find.
Modifications
Result
It will be easier for new users to find information.
Test Plan
No functional change. Existing tests continue to pass.