Add initial documentation

virtUOS · Jan 28, 2024 · 070c0b9 · 070c0b9
1 parent 42299ce
commit 070c0b9
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# Opencast Capture Agent Display
+
+Software backend for displays showing the current state of Opencast capture agents.
+
+## Example
+
+The display control in action:
+
+https://github.com/virtUOS/opencast-ca-display/assets/1008395/ead22cd2-9d7a-4d26-97ae-e5744d23952d
+
+- The display and laptop do not know about each other
+- The laptop is running an Opencast capture agent
+- When the laptop starts capturing video, the display shows an active recording