1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b071795
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Personality Test
+
+This was my first year's end term university project. This is not complete or featurefull but it intended to serve as a memory for me. It was an interesting idea back then none the less.
+
+This application presents a quiz containing 4 question that test your personality.
+
+## Install
+
+1. Clone this repository or download the source files on your local machine.
+2. Install the required dependencies
+    - `pillow`
+    - `mariadb-connector`
+    - `tkinter`
+
+## Run
+
+From the project's root folder, run the following command.
+`python main.py`
+
+Vallah! A nice looking application screen pops up.
+
+## Known Bugs
+
+The 'Show Records' screen only shows up when atleast one user has attemped the test.