aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTaylor C. Richberger <Taywee@gmx.com>2016-05-06 16:04:30 -0600
committerTaylor C. Richberger <Taywee@gmx.com>2016-05-06 16:04:30 -0600
commitd619e095c21ba623aac577f9572bc8acd59a5d16 (patch)
treeadcb2a1decc72cccbd08ef104d423d02e786229e /README.md
parentbump version (diff)
downloadargs.hxx-d619e095c21ba623aac577f9572bc8acd59a5d16.tar.xz
improve installation and documentation1.2.4
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 20 insertions, 3 deletions
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