From ebbf96ae8ae6eb981c71506e556c291bd49079e5 Mon Sep 17 00:00:00 2001
From: Harel Ben-Attia <harelba@gmail.com>
Date: Thu, 10 Sep 2020 16:18:53 +0300
Subject: website readme

---
 mkdocs/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 mkdocs/README.md

diff --git a/mkdocs/README.md b/mkdocs/README.md
new file mode 100644
index 0000000..147e71a
--- /dev/null
+++ b/mkdocs/README.md
@@ -0,0 +1,24 @@
+
+# Generate web site
+
+# mkdocs folder under project root
+$ `cd mkdocs`
+
+* create a pyenv virtual environment 
+
+$ `pip install -r requirements.txt`
+
+$ `./generate-web-site.sh` (static files will be generated into `./generated-site`)
+
+$ `git checkout gh-pages`
+
+$ `cd ../`   # back to project root
+
+$ `scp -r mkdocs/generated-site/* ./`
+
+$ `git add` all modified files
+
+* commit to git 
+
+$ `git push origin gh-pages`
+
-- 
cgit v1.2.3