Updated README.md (added Installing information, contribution instructions, unit testing instructions) #30
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
… guide, and table of contents along with easier to understand examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This change adds information regarding how to install, contribute to, and perform unit testing on the project. It also fixes many markdown errors with the original documentation and reformatted the README to be easier to read and have a more logical flow of information. Some additional simple examples on using the project were added to not intimidate new users with the much more advanced examples included in the original documentation. Finally, a table of contents was added, as the documentation had gotten quite long so I thought this would improve accessibility.