Add docs building instructions.

2017-02-02 12:12:10 +03:00
parent b98b9fedce
commit 9cd4e6f23a
1 changed files with 21 additions and 1 deletions
--- a/docs/README.md
+++ b/docs/README.md
@@ -1 +1,21 @@
-# Grafana-Zabbix Documentation
+# Grafana-Zabbix Documentation
+
+## Building docs
+To build this docs on your computer you need [git-lfs](https://git-lfs.github.com/) and [mkdocs](http://www.mkdocs.org/) installed.
+
+Clone repo
+```
+git clone https://github.com/alexanderzobnin/grafana-zabbix
+```
+Check images in `docs/sources/img/`. If this folder is empty, run 
+```
+git lfs fetch --all
+```
+
+Build docs
+```
+cd docs/
+mkdocs build --clean
+```
+
+Built docs will be placed in `site/` directory.