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.

Sign up for GitHub

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

Jump to bottom

Update README to reflect new format #98

Merged

proffapt merged 2 commits into master from update-docs

Aug 12, 2023

Member

ashwinpra commented Aug 12, 2023

As the name suggests, updated README to reflect the new format of executing
I have tried to make it as concise as possible while including all cases, but there is still room for improvement, and suggestions are welcome
Addresses 2nd (and potentially even 3rd) point of Better README #93

ashwinpra and others added 2 commits

August 12, 2023 13:54


          update docs to reflect new format

b33ee9a


          docs(README): Updated basic documentation structure

a0f940e

proffapt approved these changes

View reviewed changes

Member

proffapt left a comment

LGTM.
For now the priority is to just update it to the extent where people can use it, improvements can be done later

proffapt merged commit 5d59d63 into master

proffapt deleted the update-docs branch

August 12, 2023 13:32

proffapt mentioned this pull request

Better README #93

Closed

3 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment