From 3ead88da48e4c8770d8b31fcd521ffe522ca06e6 Mon Sep 17 00:00:00 2001
From: "Glenn Y. Rolland" <glenux@glenux.net>
Date: Sun, 19 Apr 2020 12:07:35 +0200
Subject: [PATCH] Add documentation

---
 QUESTIONS.md  |  0
 README.md     | 43 ++++++++++++++++++++++++++++++++++---------
 REFERENCES.md |  0
 3 files changed, 34 insertions(+), 9 deletions(-)
 create mode 100644 QUESTIONS.md
 create mode 100644 REFERENCES.md

diff --git a/QUESTIONS.md b/QUESTIONS.md
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index 72a835f..ceebc74 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,42 @@
-README
-======
+# Teaching-Boilerplate
 
-Usage
------
+## Prerequisites
+
+Make sure you have python and node installed
+
+Install python packages
+
+    pip install -U pipenv
+    pipenv install
+
+Install node packages
+
+    npm install
 
 
-First install stasis via bundle
+## Usage
 
-  bundle install --path vendor/bundle
+### Watch mode
 
-Then run stasis once or in devel mode
+This mode allows you the result on-the-fly as you makea changes in the content.
 
-  bundle exec middleman
+To use watch mode, type:
 
-And get the result into the public/ directory !
+    make watch
 
+To use watch mode for slides only type:
+
+    make watch-slides
+
+To use watch mode for docs only type:
+
+    make watch-docs
+
+
+### Build mode
+
+This mode builds final content for delivery (website, PDF files)
+
+To use build mode:
+
+    make build
diff --git a/REFERENCES.md b/REFERENCES.md
new file mode 100644
index 0000000..e69de29