From 7c5e89b4a14d30325f71bdc637e326937d47d7c1 Mon Sep 17 00:00:00 2001
From: Henk Kalkwater <chris@netsoj.nl>
Date: Mon, 28 Dec 2020 21:54:12 +0100
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..32a9ca9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Kerstezel client
+Client for the Kerstezel server. This project is intended to run on a Raspberry Pi.
+
+## Dependencies
+* [BCM2835](https://www.airspayce.com/mikem/bcm2835/) if not built with the SPOOF option. Licensed
+  under the GPLv3, which is how this program acquired its license.
+
+## Building
+Your standard CMake project
+
+1. `mkdir build && cd build`
+2. `cmake ..` or `cmake -DSPOOF ..` to built without the BCM2835 library (which makes this program 
+    practically useless, but it may be useful for debugging)
+3. `make`
+4. `sudo make install`
+
+This project also contains an init script, under the name "init".
+
+## Running
+```sh
+kerstezel ADDRESS_OF_KERSTEZEL_SERVER KERSTEZEL_SERVER_PORT
+```
+
+Note that this program just quits whenever it detects an anomality or the connection to the server
+breaks.
+
+The program sends a short pulse over [pin 17](https://pinout.xyz/pinout/pin11_gpio17) when the Santa
+should drum.