aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2017-08-14 15:13:23 -0700
committerYann Collet <cyan@fb.com>2017-08-14 15:13:23 -0700
commitaea7d521aed2506270a14d8e901ea657d6a1faf4 (patch)
treed1a8b349374df28713f574862adc8b6182557c0e /INSTALL
parent228e26ee63818c22ea9c4aff0eb47d82306d44e5 (diff)
downloadlz4-aea7d521aed2506270a14d8e901ea657d6a1faf4.tar.gz
better respect GNU standard Makefile conventions
supports lowercase directory variables add an "Installation" section in README.md added an INSTALL file
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL13
1 files changed, 13 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..8f61221e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,13 @@
+Installation
+=============
+
+`make`
+`make install` # this command may require root access
+
+LZ4's `Makefile` supports standard [Makefile conventions],
+including [staged installs], [directory redirection], or [command redefinition].
+
+[Makefile conventions]: https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
+[staged installs]: https://www.gnu.org/prep/standards/html_node/DESTDIR.html
+[directory redirection]: https://www.gnu.org/prep/standards/html_node/Directory-Variables.html
+[command redefinition]: https://www.gnu.org/prep/standards/html_node/Utilities-in-Makefiles.html