about summary refs log tree commit diff
diff options
context:
space:
mode:
authorChristian Neukirchen <chneukirchen@gmail.com>2015-08-27 13:53:14 +0200
committerChristian Neukirchen <chneukirchen@gmail.com>2015-08-27 13:53:14 +0200
commitbe322c569708ed17cc53c068d89d3bb755cb354f (patch)
tree1c606d55320d6d7dfaea788c96bfe6e9fff0f1fa
parent40f5d8c7e07fc36be27ce92de54398ce557df246 (diff)
downloadnq-be322c569708ed17cc53c068d89d3bb755cb354f.tar.gz
nq-be322c569708ed17cc53c068d89d3bb755cb354f.tar.xz
nq-be322c569708ed17cc53c068d89d3bb755cb354f.zip
README.md: document make install
Closes #11.
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6ef49fb..4d48064 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,15 @@ implemented as shell-script calling `tail`.)
 `flock` from util-linux, and only has a timer resolution of 1s.
 Lock files from `nq` and `nq.sh` should not be mixed.)
 
+## Installation
+
+Use `make all` to build, `make install` to install relative to `PREFIX`
+(`/usr/local` by default).  The `DESTDIR` convention is respected.
+You can also just copy the binaries into your `PATH`.
+
+You can use `make check` to run a simple test suite, if you have
+Perl's `prove` installed.
+
 ## Copyright
 
 nq is in the public domain.