From 30393ee632bde2955f74e83df3067a0fcbf59f2b Mon Sep 17 00:00:00 2001
From: ComFreek <comfreek@outlook.com>
Date: Thu, 3 Dec 2020 15:30:57 +0100
Subject: [PATCH] Update README.md

---
 README.md | 32 ++++++++++++++++++++++++--------
 1 file changed, 24 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 8c9d95f5..80994f9b 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,26 @@
-## Project Configuration
-- 1. Get Unity 2019.4.x (LTS). We update this to the newest LTS version periodically, but any 2019.4 version should work, you can ignore the version warning.
-- 2. Clone this repository
-- 3. Get the [FrameIT archives](https://github.com/UFrameIT/archives), make sure to update the submodules with this [script](https://gist.github.com/ComFreek/dcadfec0214d87e9ad3268e61479d05b)
-- 4. Install [IntelliJ](https://www.jetbrains.com/de-de/idea/)
-- 5. Clone and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the [Server Component](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt)
-- 6. Congratulations! You have all components. Just make sure to run the server first via IntelliJ if you want to run the game inside Unity.
+# UFrameIT
 
+say what uframeit is in one sentence, link to official website. say what this repo contains.
 
-For more information about the project, please visit https://uframeit.github.io/
+For more information about the project, please visit <https://uframeit.github.io/>
+
+## Installation (for end users)
+
+LINK TO LATEST RELEASE.
+
+## Installation (for developers)
+
+First, you have to set up a development environment:
+
+1. Install [Unity](https://unity3d.com/de/get-unity/download) 2019.4.x (LTS). We periodically update to the latest LTS version. Currently, any 2019.4 version should work; you can safely ignore any version warnings popping up.
+2. Clone this repository: `git clone https://github.com/UFrameIT/UFrameIT.git`
+3. Get the [FrameIT archives](https://github.com/UFrameIT/archives), make sure to update the submodules with this [script](https://gist.github.com/ComFreek/dcadfec0214d87e9ad3268e61479d05b)
+4. Install [IntelliJ IDEA](https://www.jetbrains.com/de-de/idea/)
+5. Clone [MMT](https://github.com/UniFormal/MMT/tree/devel), which also contains the [FrameIT MMT server](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt), on the *devel* branch: `git clone --branch devel https://github.com/UniFormal/MMT.git`
+and [install](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) the [Server Component]
+
+### Running
+
+1. Start Unity and open the project in this repo?
+2. Follow the [FrameIT MMT server's usage guide](https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt) for how to start the FrameIT MMT server
+3. Run the game in unity
-- 
GitLab