Improve the readme build instructions.

mF2C · Jun 12, 2019 · 04ac7ee · 04ac7ee
1 parent a92add8
commit 04ac7ee
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 *~
 build
 _build
-.vscode
+.vscode
+.venv/
+
diff --git a/README.md b/README.md
@@ -2,8 +2,22 @@
 
 Public documentation for the mF2C System
 
-This documentation includes both the developer and user guide for the mF2C System developed in https://github.com/mF2C.
+This documentation includes both the developer and user guide for the 
+mF2C System developed in https://github.com/mF2C.
 
-You can browse the rendered documentation on ReadTheDocs.org.
+You can browse the rendered documentation on 
+[https://mf2c-project.readthedocs.io/](https://mf2c-project.readthedocs.io/).
+
+## Building
+
+Install sphinx and the ReadTheDocs theme via pip, then run `make html`.
+
+```
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+make html
+```
+
+The documentation will be generated in `_build/html/index.html`.
 
-You can build the documentation locally by checking out this repository and running the command `make html`. The root of the generated documentation will appear in build/html/index.html.
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+sphinx==2.1.1
+sphinx_rtd_theme==0.4.3
+