From 7209ff4906635e487a4347617ed2a000eb5fe6f7 Mon Sep 17 00:00:00 2001
From: Jovan Gerodetti <jovan.gerodetti@titannano.de>
Date: Thu, 8 Nov 2018 00:00:03 +0100
Subject: [PATCH] write a slighty better README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++----
 1 file changed, 34 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index f0d6a9c..b081921 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,36 @@
-# SystemJS
+# Workbox
 
-SystemJS is intended to be a JavaScript based web runtime environment. 
-It will provide a UI framework, Window Manager, Console, Virtual Filesystem and more.
+Workbox is a desktop environment (simulator?) in your web browser.
+Currently it can't do a lot and is mostly very alpha.
 
-I will add more details soon.
+But it's build with web workers, so that's cool.
+
+## Install
+
+To locally install Workbox on your machine you have to clone the repo,
+
+```
+git clone git@github.com:TitanNanoDE/Workbox.git
+```
+
+install all dependencies,
+
+```
+npm i
+```
+
+and you might have to set up sub modules.
+Depending on the current state of the project, there will be different sub modules.
+
+```
+git submodule init
+```
+
+## Build
+To build the project, make sure you have `gulp-cli`, then run it inside the project dir.
+```
+gulp
+```
+
+## Run
+To run Workbox it has to be served by a web server. You can use Nginx, Apache2 or anything else.