Skip to content

Commit d65bf6b

Browse files
committed
README.rst: Add Build and Development instructions
1 parent ae06441 commit d65bf6b

File tree

1 file changed

+107
-2
lines changed

1 file changed

+107
-2
lines changed

README.rst

+107-2
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,113 @@ We appreciate any help!
7070
BUILD & DEVELOPMENT
7171
-------------------
7272

73-
Run ``python3 setup.py install``
73+
1. Installation instructions for **Windows** users:
7474

75-
Note: You need to have bower installed before you may install the python packages.
75+
- Clone the **coala-html** repository
76+
77+
::
78+
79+
$ git clone https://github.com/coala/coala-html.git
80+
81+
- Download and install the latest version of Node.js from `official website <https://nodejs.org/en/download/>`__.
82+
83+
- Change the directory to **coala-html** and run following command to install dependencies
84+
85+
::
86+
87+
$ python setup.py install
88+
89+
- Install **coala-bears**
90+
91+
::
92+
93+
$ pip install coala-bears
94+
95+
- Install **bower** to build static web pages
96+
97+
::
98+
99+
$ npm install -g bower
100+
101+
102+
- Run **coala-html** to display results from **coala-json**
103+
104+
::
105+
106+
$ coala-html --dir ..\Tests
107+
108+
109+
2. Installation instructions for **Ubuntu/Linux** users:
110+
111+
- Clone the **coala-html** repository
112+
113+
::
114+
115+
$ git clone https://github.com/coala/coala-html.git
116+
117+
- Install latest version of **Node.js**
118+
119+
a. For installing Node.js via Package manager on other distributions, refer `official guide <https://nodejs.org/en/download/package-manager/>`__.
120+
121+
b. For **Ubuntu/Linux** users:
122+
123+
* *Configure Node.js PPA*
124+
125+
::
126+
127+
$ sudo apt-get install curl python-software-properties
128+
$ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -
129+
130+
* *Install Node.js and npm*
131+
132+
::
133+
134+
$ sudo apt-get install nodejs
135+
136+
- *Check Node.js and npm version*
137+
138+
You can find more details about current version on node.js `official website <https://nodejs.org/>`__.
139+
140+
::
141+
142+
$ node -v
143+
144+
$ npm -v
145+
146+
- Install **bower** to build static web pages
147+
148+
::
149+
150+
$ sudo npm install -g bower
151+
152+
- Change the directory to **coala-html** and run following command to install dependencies
153+
154+
::
155+
156+
$ python3 setup.py install
157+
158+
- Install **coala-bears**
159+
160+
::
161+
162+
$ pip3 install coala-bears
163+
164+
- Allow permissions to **root user** to install node packages
165+
166+
::
167+
168+
$ sudo chown -R $USER:$GROUP ~/.npm
169+
$ sudo chown -R $USER:$GROUP ~/.config
170+
$ sudo chown -R $USER:$GROUP ~/.cache/bower/registry/registry.bower.io/lookup/
171+
$ sudo chown -R $USER:$GROUP ~/.cache/bower/packages
172+
173+
- Run **coala-html** to display results from **coala-json**
174+
175+
::
176+
177+
$ coala-html --dir ../Tests
178+
179+
For more details on using, refer to the usage_ section.
76180

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

0 commit comments

Comments
 (0)