From 1385a3cefc7312a3f18e8d78a854411b53c75e67 Mon Sep 17 00:00:00 2001 From: Ken Date: Wed, 1 Nov 2017 13:27:17 -0400 Subject: Initial commit of the new logs. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') 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) -- cgit v1.3.1