updated installation

1 files changed, 38 insertions, 2 deletions

diff --git a/INSTALL.md b/INSTALL.md
index 7f57b31..b5e82ae 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,7 +1,43 @@
 # Installation
 
-    pip3 install -r requirements.txt
+Installing as python executable using pip3 (python3)
 
-# Parser Generation (Optional)
+    git clone git@github.com:Pelagicore/qface.git
+    cd qface
+    pip3 install -e .
+
+Installs qface as an "editable" package. Means updates on the local git repo are reflected. If this is not what you want you can install it with
+
+    cd qface
+    pip3 install .
+
+
+# Setup Develoment
+
+To install the python dependencies use
+
+    cd qface
+    pip3 install -r requirements
+    pip3 install -e .
 
 For updating the grammar you also need antlr4 (see http://www.antlr.org).
+
+# Tests
+
+The commands are controlled by the cli.py script.
+
+    cd qface
+    ./cli.py --help
+
+To run the tests once
+
+    ./cli.py test
+
+To monitor the tests and auto-run the tests
+
+    cd qface
+    ./cli.py test_monitor
+
+
+
+