READMEs

README.md

@@ -8,7 +8,7 @@ A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_H
 
 - **Clean Look** <br />
 All that matters, at one glance! <br />
-*Date and Time &ndash; Upcoming Events &ndash; Public Announcement Space &ndash; News Ticker &ndash; Picture Showcase*
+*Date and Time &ndash; Upcoming Events &ndash; Public Announcements &ndash; News &ndash; Pictures*
 
 - **Easy Install** <br />
 Set up a RaspberryPi, run the [installer script](TODO), done!

ui/README.md

@@ -1,24 +1,36 @@
-# ovdashboard-ui
+# OVDashboard UI
 
-## Project setup
-```
-yarn install
-```
 
-### Compiles and hot-reloads for development
+## Quick Start
-```
-yarn serve
-```
 
-### Compiles and minifies for production
+If you only want a working installation, it is highly recommended to use the `docker` image at [`TODO`](TODO).
-```
+The image contains both the API and UI.
-yarn build
+Refer to the [main README](../README.md) for an in-depth how-to.
-```
 
-### Lints and fixes files
-```
-yarn lint
-```
 
-### Customize configuration
+## Setup for development and contribution
-See [Configuration Reference](https://cli.vuejs.org/config/).
+
+No need to fiddle around with specific Node.js versions.
+You only need a "general purpose" development setup to get this project up and running for debug and contribution purposes:
+
+- [Docker Engine](https://docs.docker.com/engine/install/)
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) (VSCode extension)
+
+Once you open this directory in VSCode, you should be prompted to reopen it in a development container.
+If not, hit `Ctrl+Alt+P` and search for "reopen in container".
+
+
+## Running the UI without the `docker` image
+
+> You probably don't need this! Usually the image is good enough!
+
+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.
+
+Then you can deploy the `dist` directory as the webroot using your favourite web server.
+
+
+## Configuration
+
+The OVDashboard UI is created using Vue.js. Even though the default config should fit most applications, you can refer to the [Configuration Reference](https://cli.vuejs.org/config/) for what can be configured additionally.