summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2015-02-14 01:18:39 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2015-02-14 01:19:32 +0100
commit38ebe658263fe5222ecf3c9fcd6322b9a8294663 (patch)
treed5e58d26f9329721dd6af0ae752ac187f42744b7 /README
parent600b006f4b66b56284595f42511a1a6a03925d37 (diff)
downloadjson-rpc-shell-38ebe658263fe5222ecf3c9fcd6322b9a8294663.tar.gz
json-rpc-shell-38ebe658263fe5222ecf3c9fcd6322b9a8294663.tar.xz
json-rpc-shell-38ebe658263fe5222ecf3c9fcd6322b9a8294663.zip
Add manpage generation, update README
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 13 insertions, 4 deletions
diff --git a/README b/README
index 0b8d43d..1d0ba87 100644
--- a/README
+++ b/README
@@ -10,16 +10,25 @@ Fuck Java. With a sharp, pointy object. In the ass. Hard. json-c as well.
Building and Running
--------------------
-Build dependencies: CMake, pkg-config, libev, Jansson, cURL, readline
+Build dependencies: CMake, pkg-config, help2man, libev, Jansson, cURL, readline
$ git clone https://github.com/pjanouch/json-rpc-shell.git
$ mkdir build
$ cd build
- $ cmake .. -DCMAKE_BUILD_TYPE=Debug
+ $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make
-Now you can run the following command to get some help about the exact usage:
- $ ./json-rpc-shell --help
+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 json-rpc-shell-*.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.
+
+Run the program with `--help' to obtain usage information.
License
-------