Added readme

This commit is contained in:
Erik Thuning 2024-09-09 11:49:25 +02:00
parent 8c9a2082fd
commit 49d41ce5ff

14
README.md Normal file

@ -0,0 +1,14 @@
# Lecturehalls-dashboard
A website that monitors devices in the lecturehalls and lists their status.
The application consists of a backend python script that does the checking,
a database to store the results and a javascript frontend that presents the
results to the user.
## Config
`config.ini.example` contains the required parameters. Copy it to `config.ini`
and update with valid values.
The included `cron.sh` should be called from cron with its absolute path.