meson: Add README.md for newcomers [skip ci]
authorLzu Tao <taolzu@gmail.com>
Sun, 9 Dec 2018 11:57:49 +0000 (18:57 +0700)
committerLzu Tao <taolzu@gmail.com>
Sun, 9 Dec 2018 11:57:49 +0000 (18:57 +0700)
contrib/meson/README.md [new file with mode: 0644]

diff --git a/contrib/meson/README.md b/contrib/meson/README.md
new file mode 100644 (file)
index 0000000..4e55ab9
--- /dev/null
@@ -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).