Skip to content

Commit c87bb33

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

File tree

1 file changed

+68
-2
lines changed

1 file changed

+68
-2
lines changed

README.rst

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

73-
Run ``python3 setup.py install``
73+
1. Clone the *coala-html* repository
7474

75-
Note: You need to have bower installed before you may install the python packages.
75+
::
76+
77+
$ git clone https://github.com/coala/coala-html.git
78+
79+
2. Install latest version of **Node.js**
80+
81+
- *Configure Node.js PPA*
82+
83+
::
84+
85+
$ sudo apt-get install curl python-software-properties
86+
$ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -
87+
88+
- *Install Node.js and npm*
89+
90+
::
91+
92+
$ sudo apt-get install nodejs
93+
94+
- *Check Node.js and npm version*
95+
96+
You can find more details about current version on node.js `official website
97+
<https://nodejs.org/>`__.
98+
99+
::
100+
101+
$ node -v
102+
v11.6.0
103+
104+
$ npm -v
105+
6.5.0
106+
107+
3. Install **bower** to build static web pages
108+
109+
::
110+
111+
$ sudo npm install -g bower
112+
113+
4. Change the directory to *coala-html* and run following command to install dependencies
114+
115+
::
116+
117+
$ python setup.py install
118+
119+
5. Install **coala-bears**
120+
121+
::
122+
123+
$ pip install coala-bears
124+
125+
6. Allow permissions to **root user** to install node packages
126+
127+
::
128+
129+
$ sudo chown -R $USER:$GROUP ~/.npm
130+
$ sudo chown -R $USER:$GROUP ~/.config
131+
$ sudo chown -R $USER:$GROUP ~/.cache/bower/registry/registry.bower.io/lookup/
132+
$ sudo chown -R $USER:$GROUP ~/.cache/bower/packages
133+
134+
7. Run **coala-html** to display results from *coala-json*
135+
136+
::
137+
138+
$ coala-html --dir ..\Tests
139+
140+
For more usage details, refer to the usage_ section.
76141

77142
LICENSE
78143
=======
@@ -93,3 +158,4 @@ your option) any later version.
93158
:target: https://codecov.io/github/coala/coala-html?branch=master
94159
.. _GIF: https://cloud.githubusercontent.com/assets/7397433/16225501/8162a2a4-37c4-11e6-96b8-3e37b705c7f3.gif
95160
.. _Live: http://coala.github.io/coala-html
161+
.. _usage: https://github.com/KVGarg/coala-html/tree/build_development_instructions#usage

0 commit comments

Comments
 (0)