Skip to content

Commit

Permalink
README.rst: Add Build and Development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
KVGarg committed Jan 16, 2019
1 parent ae06441 commit 8a05f53
Showing 1 changed file with 104 additions and 2 deletions.
106 changes: 104 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,110 @@ We appreciate any help!
BUILD & DEVELOPMENT
-------------------

Run ``python3 setup.py install``
1. Installation instructions for **Window** users:

Note: You need to have bower installed before you may install the python packages.
- Clone the **coala-html** repository

::

$ git clone https://github.com/coala/coala-html.git

- Download and install the latest version of Node.js from `official website <https://nodejs.org/en/download/>`__.

- Install **bower** to build static web pages

::

$ sudo npm install -g bower

- Change the directory to **coala-html** and run following command to install dependencies

::

$ python setup.py install

- Install **coala-bears**

::

$ pip install coala-bears

- Run **coala-html** to display results from **coala-json**

::

$ coala-html --dir ..\Tests


2. Installation instruction for **Ubuntu/Linux** users:

- Clone the **coala-html** repository

::

$ git clone https://github.com/coala/coala-html.git

- Install latest version of **Node.js**

For installing Node.js via Package manager on other distributions, refer `official guide <https://nodejs.org/en/download/package-manager/>`__.

* *Configure Node.js PPA*

::

$ sudo apt-get install curl python-software-properties
$ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -

* *Install Node.js and npm*

::

$ sudo apt-get install nodejs

* *Check Node.js and npm version*

You can find more details about current version on node.js `official website <https://nodejs.org/>`__.

::

$ node -v

$ npm -v

- Install **bower** to build static web pages

::

$ sudo npm install -g bower

- Change the directory to **coala-html** and run following command to install dependencies

::

$ python3 setup.py install

- Install **coala-bears**

::

$ pip3 install coala-bears

- Allow permissions to **root user** to install node packages

::

$ sudo chown -R $USER:$GROUP ~/.npm
$ sudo chown -R $USER:$GROUP ~/.config
$ sudo chown -R $USER:$GROUP ~/.cache/bower/registry/registry.bower.io/lookup/
$ sudo chown -R $USER:$GROUP ~/.cache/bower/packages

- Run **coala-html** to display results from **coala-json**

::

$ coala-html --dir ..\Tests

For more details on using, refer to the usage_ section.

LICENSE
=======
Expand All @@ -93,3 +194,4 @@ your option) any later version.
:target: https://codecov.io/github/coala/coala-html?branch=master
.. _GIF: https://cloud.githubusercontent.com/assets/7397433/16225501/8162a2a4-37c4-11e6-96b8-3e37b705c7f3.gif
.. _Live: http://coala.github.io/coala-html
.. _usage: https://github.com/coala/coala-html#usage

0 comments on commit 8a05f53

Please sign in to comment.