From 932dc995bc74ef04d0b65a405750bc15147cacac Mon Sep 17 00:00:00 2001
From: Bixilon <bixilon@bixilon.de>
Date: Tue, 3 Nov 2020 13:39:49 +0100
Subject: [PATCH] ReadMe.md: Add compile commands

---
 ReadMe.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/ReadMe.md b/ReadMe.md
index d37bd82be..375c4e3aa 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -69,4 +69,13 @@ Many thanks to [Credits](Credits.md).
 ## Releases and beta
 We are almost ready to release a beta once !8 is merged.
 
+## Compiling and running
+1. Install Maven and java 15 (On Ubuntu based distributions: `sudo apt install maven openjdk-15-jdk`)
+2. Clone this repo (`git clone https://gitlab.bixilon.de/bixilon/minosoft.git`)
+3. Change directory (`cd minosoft`)
+4. Checkout the branch (`git checkout <branch>`). Probably `render`
+5. Run Minosoft with `mvn javafx:run`. If any errors occur, feel free to open an issue. In this early stage it might be helpful
+ to delete the app data folder (only of minosoft).
+
+
 This readme is work in progress, things may change over time.