summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2017-08-14 22:13:23 (GMT)
committerYann Collet <cyan@fb.com>2017-08-14 22:13:23 (GMT)
commitaea7d521aed2506270a14d8e901ea657d6a1faf4 (patch)
treed1a8b349374df28713f574862adc8b6182557c0e /README.md
parent228e26ee63818c22ea9c4aff0eb47d82306d44e5 (diff)
downloadlz4-aea7d521aed2506270a14d8e901ea657d6a1faf4.zip
lz4-aea7d521aed2506270a14d8e901ea657d6a1faf4.tar.gz
lz4-aea7d521aed2506270a14d8e901ea657d6a1faf4.tar.bz2
better respect GNU standard Makefile conventions
supports lowercase directory variables add an "Installation" section in README.md added an INSTALL file
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 950e4c4..0e469c8 100644
--- a/README.md
+++ b/README.md
@@ -69,7 +69,22 @@ in single-thread mode.
[zlib]: http://www.zlib.net/
[Zstandard]: http://www.zstd.net/
-LZ4 is also compatible and well optimized for x32 mode, for which it provides +10% speed performance.
+LZ4 is also compatible and well optimized for x32 mode, for which it provides an additional +10% speed performance.
+
+
+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
Documentation