summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-11-30 10:26:41 +0100
committerJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-11-30 10:26:41 +0100
commitd8614d79a0a2515ad1544e88492548f6fc6a068a (patch)
treebb4181273931fe87dc3575da9ef581c6d26ee7e5 /INSTALL.md
parent74f2e8a8e588ceed33b3dabc1dcbca40825426e9 (diff)
downloadqtivi-qface-d8614d79a0a2515ad1544e88492548f6fc6a068a.tar.gz
updated installation
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md40
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
+
+
+
+