From 4bc674a5592c4176d698cd15a09977f9ce6f7cdb Mon Sep 17 00:00:00 2001 From: Přemysl Janouch Date: Mon, 21 Jul 2014 05:10:25 +0200 Subject: Update the README --- README | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README b/README index e036f87..2fba12a 100644 --- a/README +++ b/README @@ -14,12 +14,40 @@ kike ---- Also included is a simple IRC daemon that mostly follows the RFC's but is limited to single-server networks, due to the protocol being incredibly ugly -and tricky to implement correctly. Even so, it took me a ridiculous amount of -time to write. (But it was a valuable exercise and I can reuse the code.) +and tricky to implement correctly. It is designed for use as a regular user +application rather than a system daemon. + +So far the daemon lacks critical features, so don't even bother trying it. + +Building and Running +-------------------- +Build dependencies: openssl, clang, pkg-config, make, awk, sh + +If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work +just as good. But there's no CMake support yet, so I force it in the Makefile. + + $ git clone https://github.com/pjanouch/ZyklonB.git + $ make + +That is all, no installation is required, or supported for that matter. + +First you might want to generate a configuration file: + $ ./zyklonb --write-default-config + $ ./kike --write-default-config + +After making any necessary edits to the file (there are comments to aid you in +doing that), simply run the appropriate program with no arguments: + $ ./zyklonb + $ ./kike + +ZyklonB stays running in the foreground, so I recommend launching it inside +a Screen or tmux session. kike, on the other hand, immediately forks into the +background. Use something like `killall' if you want to terminate it. Disclaimer ---------- I am not an antisemitist, I'm just being an offensive asshole with the naming. +And no, I'm not going to change the names. License ------- -- cgit v1.2.3-70-g09d2