From 25314fd2aed81aa5281bc3d93dbcc7919368ebe1 Mon Sep 17 00:00:00 2001
From: Bicker <bickerkards@tuta.io>
Date: Wed, 22 May 2019 17:45:37 +0200
Subject: Initial commit

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

(limited to 'README.md')

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 |
+
-- 
cgit v1.2.3