aboutsummaryrefslogtreecommitdiff
path: root/contrib
diff options
context:
space:
mode:
authorLzu Tao <taolzu@gmail.com>2018-12-09 18:57:49 +0700
committerLzu Tao <taolzu@gmail.com>2018-12-09 18:57:49 +0700
commit58d8055da65f07972bf73162a5477229428b96bc (patch)
tree4a2ae168ca7f168b98d556a11655c1ad64da4a13 /contrib
parentfbc42958c087626edb24592a5ad1eb73bb6ae5cd (diff)
downloadlz4-58d8055da65f07972bf73162a5477229428b96bc.tar.gz
meson: Add README.md for newcomers [skip ci]
Diffstat (limited to 'contrib')
-rw-r--r--contrib/meson/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/contrib/meson/README.md b/contrib/meson/README.md
new file mode 100644
index 00000000..4e55ab9a
--- /dev/null
+++ b/contrib/meson/README.md
@@ -0,0 +1,34 @@
+Meson build system for lz4
+==========================
+
+Meson is a build system designed to optimize programmer productivity.
+It aims to do this by providing simple, out-of-the-box support for
+modern software development tools and practices, such as unit tests,
+coverage reports, Valgrind, CCache and the like.
+
+This Meson build system is provided with no guarantee.
+
+## How to build
+
+`cd` to this meson directory (`contrib/meson`)
+
+```sh
+meson --buildtype=release -Ddefault_library=shared -Dbuild_programs=true builddir
+cd builddir
+ninja # to build
+ninja install # to install
+```
+
+You might want to install it in staging directory:
+
+```sh
+DESTDIR=./staging ninja install
+```
+
+To configure build options, use:
+
+```sh
+meson configure
+```
+
+See [man meson(1)](https://manpages.debian.org/testing/meson/meson.1.en.html).