From 044e2a351ee1225755f9a199abf04df3c994676f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?=
 <40151420+ldericher@users.noreply.github.com>
Date: Tue, 27 Sep 2022 19:59:27 +0000
Subject: [PATCH] README files

---
 README.md    | 14 +++++++++++++-
 ui/README.md |  7 +++++++
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1b3808f..fae736c 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@ A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_H
 
 ![Screenshot](./doc/ovdashboard_en.jpg)
 
+
 ## Key Features
 
 - **Clean Look** <br />
@@ -30,4 +31,15 @@ No static strings anywhere &ndash; formats generated using [Luxon](https://momen
 
 - **Hackable** <br />
 The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br />
-*Like this layout, but want it for something completely different? Fork me!*
+*Like my layout, but want it for something completely different? Fork me!*
+
+
+## Quick Start
+
+Make sure you have a WebDAV and CalDAV server available.
+You should start with the `docker` image in any case.
+
+
+## Setup for development and contribution
+
+Refer to the specific README files for [the API](./api/README.md) and [the UI](./ui/README.md) to contribute to one of those sub-projects.
diff --git a/ui/README.md b/ui/README.md
index 71debd7..dc96245 100644
--- a/ui/README.md
+++ b/ui/README.md
@@ -27,6 +27,13 @@ If not, hit `Ctrl+Alt+P` and search for "reopen in container".
 
 However, if you want to deploy the UI on a cluster or any custom web server, go ahead.
 First, run `yarn build` in this directory - I'd recommend you use VSCode with a development container as described above.
+Alternatively, you can copy the `/html` directory from the `docker` image:
+
+```sh
+id=$(docker create TODO)
+docker cp "${id}:/html" "/path/to/dist"
+docker rm -v "${id}"
+```
 
 Then you can deploy the `dist` directory as the webroot using your favourite web server.