From 49d41ce5ff9c3d7a59e313323329bd191e0ed2a1 Mon Sep 17 00:00:00 2001
From: Erik Thuning <boooink@gmail.com>
Date: Mon, 9 Sep 2024 11:49:25 +0200
Subject: [PATCH] Added readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14bebe9
--- /dev/null
+++ b/README.md
@@ -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.