@@ -70,9 +70,99 @@ We appreciate any help!
70
70
BUILD & DEVELOPMENT
71
71
-------------------
72
72
73
- Run `` python3 setup.py install ``
73
+ 1. Installation instructions for ** Windows ** users:
74
74
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
82
+ <https://nodejs.org/en/download/> `__.
83
+
84
+ - Change the directory to **coala-html ** and run following command to
85
+ install dependencies
86
+
87
+ ::
88
+
89
+ $ python setup.py install
90
+
91
+ - Install **coala-bears **
92
+
93
+ ::
94
+
95
+ $ pip install coala-bears
96
+
97
+ - Install **bower ** to build static web pages
98
+
99
+ ::
100
+
101
+ $ npm install -g bower --save
102
+
103
+
104
+ - Run **coala-html ** to display results from **coala-json **
105
+
106
+ ::
107
+
108
+ $ coala-html --dir ..\Tests
109
+
110
+
111
+ 2. Installation instructions for **Linux ** users:
112
+
113
+ - Clone the **coala-html ** repository
114
+
115
+ ::
116
+
117
+ $ git clone https://github.com/coala/coala-html.git
118
+
119
+ - Install `asdf-vm <https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm
120
+ ?id=install-asdf-vm> `__ by referring to the guide.
121
+
122
+ - Add `Node.js <https://github.com/asdf-vm/asdf-nodejs#install >`__ plugin
123
+ using **asdf-vm ** and Install Node.js
124
+
125
+ ::
126
+
127
+ $ asdf install nodejs <version>
128
+
129
+ - *Check Node.js and npm version *
130
+
131
+ You can find more details about current version on node.js `official website
132
+ <https://nodejs.org/> `__.
133
+
134
+ ::
135
+
136
+ $ node -v
137
+
138
+ $ npm -v
139
+
140
+ - Install **bower ** to build static web pages
141
+
142
+ ::
143
+
144
+ $ npm install -g bower --save
145
+
146
+ - Change the directory to **coala-html ** and run following command to install
147
+ dependencies
148
+
149
+ ::
150
+
151
+ $ python3 setup.py install
152
+
153
+ - Install **coala-bears **
154
+
155
+ ::
156
+
157
+ $ pip3 install coala-bears
158
+
159
+ - Run **coala-html ** to display results from **coala-json **
160
+
161
+ ::
162
+
163
+ $ coala-html --dir ./coala_test_results
164
+
165
+ For more details on using, refer to the usage _ section.
76
166
77
167
LICENSE
78
168
=======
@@ -93,3 +183,4 @@ your option) any later version.
93
183
:target: https://codecov.io/github/coala/coala-html?branch=master
94
184
.. _GIF : https://cloud.githubusercontent.com/assets/7397433/16225501/8162a2a4-37c4-11e6-96b8-3e37b705c7f3.gif
95
185
.. _Live : http://coala.github.io/coala-html
186
+ .. _usage : https://github.com/coala/coala-html#usage
0 commit comments