Updated README (about docs)

This commit is contained in:
Thomas Touhey 2016-07-18 19:08:35 +02:00
parent b3379109b5
commit b1146e442b
1 changed files with 6 additions and 3 deletions

View File

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