diff options
| author | Bicker <bickerkards@tuta.io> | 2019-05-22 17:45:37 +0200 |
|---|---|---|
| committer | Bicker <bickerkards@tuta.io> | 2019-05-22 17:45:37 +0200 |
| commit | 25314fd2aed81aa5281bc3d93dbcc7919368ebe1 (patch) | |
| tree | 1995521ee652e419926de5fced0f2e3b655e70fb /README.md | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a7b6b3 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# PyQuest
+---
+> Repository for the course *Software Construction*, part of the master *Software Engineering* at the *University of Amsterdam*
+---
+
+This repository contains code implementing a Questionnaire Language (QL) in Python.
+
+## Dependencies
+### Python
+Python version 3
+
+#### Packages
+- multimethods
+- PLY
+- PyQt5
+- termcolor
+## Setup
+```
+sudo pip3 install multimethods
+sudo pip3 install ply
+sudo pip3 install pyqt5
+sudo pip3 install termcolor
+```
+
+
+## Running
+```
+python3 pyquest.py
+```
+
+### Optional arguments
+```
+-t, --test Perform tests.
+```
+
+### GUI Shortcuts
+
+| Shortcut | Action |
+| ------ | ------ |
+| `Ctrl+N`| Create a new .ql file |
+| `Ctrl+O`| Open a .ql file |
+| `Ctrl+S`| Save current .ql file |
+| `Ctrl+Shift+S`| Save as current .ql file |
+| `Ctrl+R` | Run current .ql file |
+
|