aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2015-01-17 15:54:49 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2015-01-17 16:10:12 +0100
commit7cb6fcdaff2237cd24cf22fbc739192704838b6d (patch)
treecedd22bc2e220d69212b06683b12025dc3814e1e /README
parent77509ceb56d430d949a89f2fc25aaded414193a8 (diff)
downloadponymap-7cb6fcdaff2237cd24cf22fbc739192704838b6d.tar.gz
ponymap-7cb6fcdaff2237cd24cf22fbc739192704838b6d.tar.xz
ponymap-7cb6fcdaff2237cd24cf22fbc739192704838b6d.zip
Rewrite to use CMake
Now the project is at least installable. Added a LICENSE file. Likely about to implement Lua plugins.
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 15 insertions, 7 deletions
diff --git a/README b/README
index 08d7df2..725dbe5 100644
--- a/README
+++ b/README
@@ -17,21 +17,29 @@ the maximum number of concurrent connections.
Building and Running
--------------------
-Build dependencies: GCC/Clang, GNU make, help2man, pkg-config, openssl, Jansson
+Build dependencies: CMake, pkg-config, help2man, curses, openssl, Jansson,
+ lua = 5.3 (optional)
$ git clone https://github.com/pjanouch/ponymap.git
$ git submodule init
$ git submodule update
+ $ mkdir build
+ $ cd build
+ $ cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_LUA=NO
$ 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
-First you might want to generate a configuration file:
- $ ./ponymap --write-default-config
+Or you can try telling CMake to make a package for you. For Debian it is:
+ $ cpack -G DEB
+ # dpkg -i ponymap-*.deb
-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 to retrieve
-a usage text.
+Note that for versions of CMake before 2.8.9, you need to prefix cpack with
+`fakeroot' or file ownership will end up wrong.
+
+Having the program installed, simply run it with no arguments to retrieve
+a usage text. Have fun scanning.
Author's Notes
--------------