Add installation steps, known limitations to README; move developer info to CONTRIBUTING#297
Open
ADTC wants to merge 6 commits intoflackr:masterfrom
Open
Add installation steps, known limitations to README; move developer info to CONTRIBUTING#297ADTC wants to merge 6 commits intoflackr:masterfrom
ADTC wants to merge 6 commits intoflackr:masterfrom
Conversation
Also do some formatting, add more links, and fix language issues for existing parts of the README.
Author
ADTC
changed the title
ADTC
changed the title
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
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.
Also did some Prettier formatting, added more links, and fixed language issues for existing parts of the README.
Preview Link for README.
Please feel free to add more limitations. If a dedicated section is overkill, just add
### Other known limitationsas the last section in## Known Limitationsand make a bulleted list.Update: The development & testing information has been moved to CONTRIBUTING page.
Preview Link for CONTRIBUTING.
Closes #296
Closes #283
Closes #272
Closes #267
Closes #44
Also addresses the comment here. (Not sure if it closes the whole issue; maybe not.)