From 9335e3928983cca9b29f866cf9239a10e5a478a3 Mon Sep 17 00:00:00 2001
From: luxick <git@luxick.com>
Date: Sat, 24 Feb 2018 14:20:41 +0100
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..970f872
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# DrunkSoulsStatTool
+Over-engineered statistics tool for keeping track of a drinking game 
+
+# Running the application
+## Build executable zip archive
+Run build script
+
+`$ python3 ./build.py` 
+
+The archive will be saved into the `build` folder. The file is completly standalone and can be run from anywhere.
+
+`$ ./build/dsst`
+
+## Run python script directly 
+`$ python3 ./dsst/__main__.py`
+
+# Dependencies
+- GObject (Gtk3)
+- mysqlclient (Python Mysql Driver)
+- peewee (ORM Framework)