Updated the README documentation and added licensing information #130
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
Added installation instructions in the README along with license information, citation information, and more information about the app's functionality.
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.
Description
-Did not fix any issues
-Changed installation directions in the README file to be more relevant, the file that was previously intended to run (Project.xcodeproj) no longer exists in the code repository.
-Added licensing information assuming this project abides by the MIT open source copyright license.
-Added citation information, I would suggest creating a DOI to replace the information I referenced.
I made these documentation-only changes for a class assignment, feel no pressure to accept them.
Type of Change
Please delete options that are not relevant.