-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tidy up README and add subcommand instructions #68
Conversation
@itsspriyansh We'd need to reduce the README to only the most important information and move all the detailed information to separate pages. Otherwise, someone exploring this project would never reach the part you've implemented through the readme. See #30 for reference. |
@garg3133 PR updated. How does it look now? |
@itsspriyansh Not what I meant. What I meant was to move the detailed usage sections of setting up Android/iOS requirements to separate files (as was attempted in #30 but then the author abandoned the PR) so that the README is freed up and only contains the important details. The amount of information that you added earlier in README related to your work seemed alright, we should have some basic usage about each subcommand in the main readme itself and then move the rest to corresponding files. |
@garg3133 PR updated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README looks good now.
What's left now is to link the specific subcommand docs with the appropriate sections in README and update the subcommand files for the recently merged scripts. |
This PR
README.md
.README.md
.