summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 39fa152..0689d3b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# Vainglory Gamelocker Documentation
+# vainglory-docs
+
+[http://vainglory-gamelocker-documentation.readthedocs.io/en/master/introduction.html](http://vainglory-gamelocker-documentation.readthedocs.io/en/master/introduction.html)
+
+### Setup & Run
+Install python and pip
+
+`pip install -r requirements.txt`
+
+`make html`
+
+### The tech
+- The documentation is handled by a python packaged called [Sphinx](http://www.sphinx-doc.org/en/stable/)
+- It is temporarily hosted by a service called [readthedocs](https://readthedocs.org/projects/battlerite-docs)