search

coala / coala-html

Interactive website generator using results from coala
GNU Affero General Public License v3.0
17 stars 40 forks source link

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

Closed KVGarg closed 5 years ago

KVGarg commented 5 years ago

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.

li-boxuan commented 5 years ago

Duplicate of https://github.com/coala/coala-html/issues/135