preparation for parsing and webapp splitHEADmaster

1 files changed, 32 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..28e4f8b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,32 @@
+`Warsaw Hackerspace`_  presence tracker hosted on https://at.hackersapce.pl. It
+uses dhcpd.leases file to track MAC adressess of devices connected to hs LAN
+network.
+
+.. _Warsaw Hackerspace: https://hackerspace.pl
+
+Setup
+-----
+.. code:: bash
+
+    cp at.cfg.dist at.dist
+
+    # edit config file using your favourite editor
+    $EDITOR at.cfg
+
+    # create new database file (or copy existing one)
+    sqlite3 at.db < dbsetup.sql
+
+    # create python virtual environment
+    python3 -m venv vevnv
+    ./venv/bin/python3 -m pip install -r requirements
+    ./venv/bin/python3 -m pip install gunicorn
+
+Running
+-------
+.. code:: bash
+
+   ./venv/bin/gunicorn run:app
+
+When running on OpenBSD make sure to pass '--no-sendfile' argument to gunicorn
+command. This will prevent AttributeError on os.sendfile that seems to be
+missing in this marvelous OS-es python3 stdlib.