added README file

experiments/WebUI/README.md

@@ -1,7 +1,44 @@
-# Repo for browser based StarControl Dev
+# StarControl 2020 Web UI
 
-Describe the project
+## Development
 
-## folder structure
-* Explain folder structure here
-* mandatory to include a documentation folder for, well, documentations
+This section contains instructions on the development process. 
+See also [Create React App](https://create-react-app.dev/).
+
+### Pre-requisites
+
+* Node.js
+* npm
+
+### Install packages
+
+```
+npm install
+```
+
+### Start development server
+
+```
+npm run start
+```
+
+## Build
+
+### Pre-requisites
+
+* JDK 8
+
+### Standalone simulator
+
+This section contains instructions on building the standalone simulator (it includes the web UI).
+
+**NOTE**
+* This requires access to the `starfish` repository.
+
+* Check out the `starfish` repository to the same directory as the `r2c2` repository (such that they are siblings in the same directory).
+* Switch to the base directory of `starfish`.
+* Run:
+    ```
+    ./gradlew clean && ./gradlew :simulator2:build
+    ```
+* The simulator distribution can be found at `simulator2/build/distributions/starfish-simulator.zip`.