Skip to content

Commit 9931f21

Browse files
committed
added installation instructions to readme
1 parent 43d7536 commit 9931f21

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.rst

+18-4
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,22 @@ To contribute, file issues on Github or email me <[email protected]>.
55
Text in this document may be shared under the terms of
66
Creative Commons Zero <http://creativecommons.org/publicdomain/zero/1.0/>.
77

8-
Note that this Sphinx document requires that you have
9-
"sphinx-bootstrap-theme" installed from PyPI, as well
10-
as sphinx itself.
8+
For Developers
9+
======================
10+
11+
To install the project, fork this repository and clone it to your computer. Get dependencies
12+
by typing the following two commands::
13+
14+
sudo apt-get install python-sphinx
15+
sudo pypi-install sphinx-bootstrap-theme
16+
17+
You may need to install pypi-install in order to run the above commands. To install pypi-install, type::
18+
19+
sudo apt-get install python-stdeb
20+
21+
Once you've installed the dependencies, you can render the project by typing::
22+
23+
make html
24+
25+
You will find the rendered pages in *_build/html*. A good place to start looking around is *index.html*.
1126

12-
-- Asheesh.

0 commit comments

Comments
 (0)