Improve README #14
Merged
Improve README #14
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
Screenshots on the front page README would require the user to scroll quite a bit to see the rest of the README, where the future Documentation section would be filled out. Moving the screenshots to their own README file and linking to it from the front-page README will alleviate this issue
Replace installation section with the commands needed to install and run the codebase
|
Hello, It will be greatly helpful if you can post how to use and update the app code in the documentation section. Thank you. |
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.
Hello @ATF19,
The following PR looks to improve the README.md file of react-native-shop-ui by moving the screenshots to a separate
README.mdfile to lessen the amount users have to scroll to get to the rest of yourREADME.mdfile. Additionally, I've added the specific instructions needed to run this application.In the interest of full transparency, this edit is for an assignment for a university technical writing course. A higher grade will be rewarded if PRs are approved. Please let me know if there are any issues with this PR that could be rectified, or any further additions I can make, in order to achieve an approval.
Additionally, I can fill out the
Documentationsection of the mainREADME.mdfile if you can provide more details on what you would like to be written there =)