diff options
| author | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-10 22:27:50 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx.manpages@gmail.com> | 2022-07-10 23:01:56 +0200 |
| commit | 77160b72c90184123097f621880ae3842f890357 (patch) | |
| tree | b204ffa844ebe0ba864f7712c4192533e2f5c5a6 /INSTALL | |
| parent | 30f8f9456e4428cfeba9223a098741fd1dcadc59 (diff) | |
Makefile, README, INSTALL: Improve INSTALL documentation
Add a 'make help' target to document the features of our Makefile.
Move all documentation about installing from the README to a new
INSTALL file, following GNU coding standards. See
<https://www.gnu.org/prep/standards/html_node/Releases.html#Releases>.
INSTALL contains minimal information, and defers to 'make help'
for the rest.
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..75c5dff01 --- /dev/null +++ b/INSTALL @@ -0,0 +1,13 @@ +Run `make help` to see a list of targets and a brief description. + +Normally, you'll want to run `make install`, which will copy these manual +pages to <$(DESTDIR)$(mandir)/man*>, which by default is +</usr/local/share/man/man*>. + +To install to a different path, modify the appropriate directory variables. +See <https://www.gnu.org/prep/standards/html_node/Directory-Variables.html>. + +You can use multiple threads with this Makefile safely, which will run +considerably faster: `make -j install`. + +The Makefile used by this project requires GNU make(1). |