From b29c3da448b55caa3e12241ac97cf825f3755221 Mon Sep 17 00:00:00 2001
From: LongHairedHacker <sebastian@sebastians-site.de>
Date: Thu, 10 Jan 2019 20:04:33 +0100
Subject: [PATCH] Added a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cc938ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+SatNOGS Demo Display
+====================
+A hacky python script rendering the waterfall of the latest SatNOGS observation,
+to a nice info graphic.
+Currently limited to a fixed resolution of 1280x1024.
+
+Install
+-------
+```
+python3 -m venv virtenv
+source virtenv/bin/activate
+
+pip install -r requirements.txt
+```
+
+
+Usage
+-----
+1. Run update.py once a minute. e.g. using cron
+2. Run something to display the resulting waterfall.png. e.g. `feh -F -D 30 waterfall.png`
+3. Fun & Profit