From b1146e442b23293ed032dc17184d24a2263e1d4d Mon Sep 17 00:00:00 2001 From: Thomas Touhey Date: Mon, 18 Jul 2016 19:08:35 +0200 Subject: [PATCH] Updated README (about docs) --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca45a57..6377726 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,17 @@ The original docs have been written to markdown and are available [in the wiki]( First, create the Makefile configuration with the `./configure` command. Defaults settings should be enough, but if you want to change the installation directories, see `./configure --help`. -To build the library, simply `make`. - +To build the library, simply `make`. To install the built library, use `make install` (it will use the configuration generated by `./configure`). +To build the manpages (requires a2x/asciidoc, `sudo apt-get install asciidoc` under Debian), just run `make all-doc`. +To install it, run `make install-doc`. + If you want to contribute, these Makefile targets might help you : - `make clean`: clean the object files ; - `make fclean`: clean the object files and the final library ; -- `make re`: cleans the object files and the final library, then makes the project. +- `make re`: cleans the object files and the final library, then makes it all again ; +- `make clean-doc`: cleans the build manpages. ## Using