From d619e095c21ba623aac577f9572bc8acd59a5d16 Mon Sep 17 00:00:00 2001 From: "Taylor C. Richberger" Date: Fri, 6 May 2016 16:04:30 -0600 Subject: improve installation and documentation --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1b0d15a..e77505e 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,26 @@ There are tons of things this library does not do! # How do I use it? -Just copy the header into your source tree, or put it somewhere that your -compiler can see. As long as you can `#include "args.hxx"` and use c++11, you -should be good to go. +```shell +sudo make install +``` + +Or, to install it somewhere special (default is `/usr/local`): + +```shell +sudo make install DESTDIR=/opt/mydir +``` + +You can also copy the file into your source tree, if you want to be absolutely +sure you keep a stable API between projects. + +## I also want man pages + +```shell +sudo make installman +``` + +This requires Doxygen # Examples -- cgit v1.2.1