Skip to content
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

README.rst: Add setup instructions to README.md #152

Closed
KVGarg opened this issue Jan 11, 2019 · 1 comment
Closed

README.rst: Add setup instructions to README.md #152

KVGarg opened this issue Jan 11, 2019 · 1 comment

Comments

@KVGarg
Copy link

KVGarg commented Jan 11, 2019 •
edited
Loading

Currently, in README.md there is no information provided on how to run coala-html on a project which makes difficult for a new contributor on how to and what commands should be used to run coala-html.
So, need command instruction's with a small description what each command does to the README.md.
IMO we should add instructions from installing nodejs till the executing instruction of coala-html.
Make sure to use keyword sudo where needed in terminal commands.

This could be a suitable issue for newcomers.
@KVGarg KVGarg changed the title Add setup instructions to README.md README.rst: Add setup instructions to README.md Jan 11, 2019
@li-boxuan
Copy link
Member

Duplicate of #135

@li-boxuan li-boxuan marked this as a duplicate of #135 Jan 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@li-boxuan @KVGarg