From a8bd8f84280d365ba8d8489f799868ab4e0eec6a Mon Sep 17 00:00:00 2001 From: Chris Josten Date: Mon, 28 Dec 2020 21:30:04 +0100 Subject: [PATCH] Update README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..baa9471 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Kerstezel Server +This is the server component of the Kerstezel project. This renders the public webpage and forwards +the drum commands from our beloved users towards the Santa of IAPC. + +## Building (normal) +1. Install dmd and dub from your distro's package manager (or for those unlucky enough to live without + a package managers: https://dlang.org/download.html) +2. Make sure openssl development libraries are installed. +3. Run `dub build`. This will automatically download other dependencies and compile them. + +## Building (nix) +1. `nix build .` + +## Running +1. Run the produced `kerstezel` binary. Note that the built-in file webserver expects to have + the `statisch` folder in its working directory. It will listen on port 8090 for http-requests and + on port 9305 for the kerstezel-client.. If you want to change any of this, edit the program and + recompile.