Skip to content

Commit c310892

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

File tree

1 file changed

+89
-2
lines changed

1 file changed

+89
-2
lines changed

README.rst

+89-2
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,95 @@ 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 **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+
Refer `official guide <https://nodejs.org/en/download/package-manager/>`__, for installing Node.js via Package manager.
120+
121+
- *Check Node.js and npm version*
122+
123+
You can find more details about current version on node.js `official website <https://nodejs.org/>`__.
124+
125+
::
126+
127+
$ node -v
128+
129+
$ npm -v
130+
131+
- Install **bower** to build static web pages
132+
133+
::
134+
135+
$ sudo npm install -g bower
136+
137+
- Change the directory to **coala-html** and run following command to install dependencies
138+
139+
::
140+
141+
$ python3 setup.py install
142+
143+
- Install **coala-bears**
144+
145+
::
146+
147+
$ pip3 install coala-bears
148+
149+
- Change ownership to install packages required by bower
150+
151+
::
152+
153+
$ sudo chown -R $USER:$GROUP ~/.config/configstore
154+
155+
- Run **coala-html** to display results from **coala-json**
156+
157+
::
158+
159+
$ coala-html --dir ./coala_test_results
160+
161+
For more details on using, refer to the usage_ section.
76162

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

0 commit comments

Comments
 (0)