From a75ca98ff30778dda885d4240243ecc0c8af1cf8 Mon Sep 17 00:00:00 2001
From: Nicolai Hollup Brand <nicolai.brand@ntnu.no>
Date: Tue, 23 May 2023 13:23:12 +0200
Subject: [PATCH] feat: readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be881a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Paths
+A graphical game for the course Programming 2 IDATT2001.
+Made by Nicolai H. Brand and Trym H. Gudvangen.
+
+
+## Installation and run
+
+### Dependencies
+
+- `git`: to download the repository
+- `JDK`: Java Development Kiy version 1.7 or higher
+- `Maven`: Build tool
+
+
+### Installation
+
+```sh
+git clone git@gitlab.stud.idi.ntnu.no:nicolahb/paths.git
+```
+
+### Run
+
+```sh
+cd paths
+```
+
+```sh
+mvn javafx:run
+```
-- 
GitLab