diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -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) |
