Revise README.md for Consistency and Useability #493
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.
Summary
This PR cleans up the README.md for accessibility, readability, and standardization.
Description
The current README gets the job done. However, it's quite messy when you try to edit it, it doesn't follow the markdown standards, has dead links/anchors, and there's an invalid paragraph closing tag (
<p/>
) at the top! I thought that, before I submitted a solution, it would be helpful to future contributors to have a cleaner README to edit.How Has This Been Tested?
Make sure all below guidelines are followed else PR will get rejected: