README

README.md

@@ -37,9 +37,50 @@ The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](ht
 ## Quick Start
 
 Make sure you have a WebDAV and CalDAV server available.
-You should start with the `docker` image in any case.
+For an all-in-one solution, consider setting up an account on a [Nextcloud](https://nextcloud.com/) instance!
+
+The intended installation method is as follows:
+1. Have a Raspberry Pi (3 or later) connected to a HDMI screen
+0. Boot up "Raspberry Pi OS 64 bit" (lite) and connect the Pi to your local network
+0. Download (and review) the [OVDashboard installer](TODO), then run it from a terminal
+
+If you feel adventurous and want to skip the script review, run `curl --proto '=https' --tlsv1.2 -sSf 'TODO' | sh` instead.
+
+For a better understanding of your newly created OVDashboard, refer to the [about section](TODO).
 
 
 ## 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.
+
+
+## About the "default" OVDashboard deployment
+
+The default deployment is made up of three parts: The **installer** which runs once, prepares your device for OVDashboard usage and deploys the **client** and the **service**.
+
+The **client** will connect to and display your OVDashboard.
+
+The **service** will run continuously and makes sure your OVDashboard is up to date.
+
+
+### The OVDashboard installer will:
+
+- install some general-purpose packages
+- make you set a new password, if you haven't yet
+- install and set up Docker Engine and Mozilla Firefox
+- (optionally) enable SSH and/or VNC access to your device
+- create the OVDashboard configuration directory `/usr/local/etc/ovdashboard` on your device
+- set up the OVDashboard service
+- (optionally) set up your device to auto-run the OVDashboard client
+
+
+### The OVDashboard service will:
+
+- regularly pull the latest `docker` image from [`TODO`](TODO), containing both the OVDashboard API and UI
+- ensure a container of that image is always running, using your OVDashboard configuration directory
+
+
+### The OVDashboard client will:
+
+- open Mozilla Firefox in full-screen mode and open the local OVDashboard UI
+- enable auto-hiding your mouse cursor