From 3393504fe8bcffda1adf8b46bf8f7eed0b5563b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim=20=C3=9Cbelh=C3=B6r?= <tim.uebelhoer@rwth-aachen.de>
Date: Fri, 16 Mar 2018 15:20:36 +0100
Subject: [PATCH] Update README.md

---
 README.md | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8d053aa..2bab264 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,13 @@
-This projects implements a FMU client which performs the simulation in (soft) realtime.
+# ModeliChart Backend
 
-The backend is controlled via grpc (googles remote procedure call framework), see https://git.rwth-aachen.de/ModeliChart/ModeliProtocol.
-The protocol must be compiled for the platform on which it will be deployed.
\ No newline at end of file
+This projects implements a FMU client which performs the simulation in realtime.
+Linux and Windows are supported.
+
+# Requirements
+For the protocol see https://git.rwth-aachen.de/ModeliChart/ModeliProtocol.
+
+# Build
+Boost and grpc are required for compilation.
+The easiest way to obtain the libraries on windows is vcpkg.
+The projects are Visual Studio projects one project targets Windows the other one Linux.
+Linux installation of the libraries via apt or build from source.
\ No newline at end of file
-- 
GitLab