main README
This commit is contained in:
parent
d92e759cae
commit
994dc827db
1 changed files with 8 additions and 3 deletions
11
README.md
11
README.md
|
@ -27,7 +27,7 @@ Change the Logo – Put your own Title – Publish Pictures – Crea
|
|||
OVDashboard is made for the big screen – but it also shines in your visitors' mobile browsers!
|
||||
|
||||
- **Locale Aware** <br />
|
||||
No static strings anywhere – formats generated using [Luxon](https://moment.github.io/luxon/#/), which [respects your browsers' settings](./doc/ovdashboard_de.jpg)!
|
||||
No localized strings anywhere – formats generated using [Luxon](https://moment.github.io/luxon/#/), which [respects your browsers' settings](./doc/ovdashboard_de.jpg)!
|
||||
|
||||
- **Hackable** <br />
|
||||
The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br />
|
||||
|
@ -36,19 +36,24 @@ 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.
|
||||
For an all-in-one solution, consider setting up an account on a [Nextcloud](https://nextcloud.com/) instance!
|
||||
Make sure you have a WebDAV and CalDAV account available.
|
||||
For an all-in-one solution, consider setting up an account on a [Nextcloud](https://nextcloud.com/) instance! <br />
|
||||
On your WebvDAV account, create a resource (directory) named `ovdashboard`.
|
||||
|
||||
The intended installation method is as follows:
|
||||
1. Have a Raspberry Pi (3 or later) connected to a HDMI screen
|
||||
1. Boot up "Raspberry Pi OS" (64 bit, lite) and connect the Pi to your local network
|
||||
1. Download (and review) the [OVDashboard installer](TODO), then run it from a terminal
|
||||
1. Reboot the Raspberry Pi
|
||||
|
||||
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).
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue