hiro/yabar
1
0
Fork 0
mirror of https://github.com/vale981/yabar synced 2025-03-04 17:11:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add building instructions for documentation to README

Browse source
This commit is contained in:
Jack Henschel 2017-04-14 20:49:55 +02:00
parent f54f04338e
commit a17d63448e
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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: