From 867d5cc57cb6922c10ffd8e1a76314a293e58103 Mon Sep 17 00:00:00 2001
From: DL6ER <dl6er@dl6er.de>
Date: Tue, 1 May 2018 14:17:37 +0200
Subject: [PATCH] Add deployment instructions to readme

Signed-off-by: DL6ER <dl6er@dl6er.de>
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 9362d90..160f3b5 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,10 @@ sudo pip install mkdocs
 sudo pip install mkdocs-material
 mkdocs serve
 ```
+
+Deploying to GitHub pages:
+```
+mkdocs gh-deploy
+```
+MkDocs will build the docs and use the `ghp-import` tool to commit them to our `gh-pages` branch and also automatically push the `gh-pages` branch to GitHub.
+Warning: Be aware that you will not be able to review the built site before it is pushed to GitHub! Therefore, you **must** verify any changes you make to the docs beforehand by using the `mkdocs serve` command and reviewing the built files locally.