diff --git a/README.md b/README.md index 17f68ae..b7ffcd2 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,17 @@ You can install yabar as follows: $ git clone https://github.com/geommer/yabar $ cd yabar - $ make + $ make yabar $ sudo make install If you use libconfig 1.4.x (still used in Ubuntu 14.04 and Debian Jessie), please type `export CPPFLAGS=-DOLD_LIBCONFIG` then build using `make` as usual. +Building the documentation (man page) requires AsciiDoc and a few other dependencies: `asciidoc docbook-xml xsltproc` + + $ make docs + +This will generate the yabar man page inside `doc/yabar.1`. + ## Configuration Yabar currently by default accepts configuration from the config file `~/.config/yabar/yabar.conf` or using `yabar -c [CONFIG_FILE]`. The config file should like something like this: