aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 21 insertions, 11 deletions
diff --git a/README b/README
index 54adba7..f70a3cc 100644
--- a/README
+++ b/README
@@ -26,26 +26,36 @@ Some interesting features:
- epoll support on Linux
- superfast build time, small memory footprint
-Building and Running
---------------------
-Build dependencies: openssl, clang, pkg-config, GNU 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.
+Building
+--------
+Build dependencies: CMake, pkg-config, help2man, awk, sh, openssl
$ git clone https://github.com/pjanouch/ZyklonB.git
+ $ mkdir build
+ $ cd build
+ $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release
$ make
-That is all, no installation is required, or supported for that matter.
+To install the application, you can do either the usual:
+ $ make install
+
+Or you can try telling CMake to make a package for you. For Debian it is:
+ $ cpack -G DEB
+ # dpkg -i sdtui-*.deb
+Note that for versions of CMake before 2.8.9, you need to prefix cpack with
+`fakeroot' or file ownership will end up wrong.
+
+Running
+-------
First you might want to generate a configuration file:
- $ ./zyklonb --write-default-config
- $ ./kike --write-default-config
+ $ 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
+ $ 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