]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Rename and update build instruction in README file to README.md
authorLzu Tao <taolzu@gmail.com>
Tue, 27 Nov 2018 17:10:04 +0000 (00:10 +0700)
committerLzu Tao <taolzu@gmail.com>
Tue, 27 Nov 2018 18:08:34 +0000 (01:08 +0700)
contrib/meson/README [deleted file]
contrib/meson/README.md [new file with mode: 0644]

diff --git a/contrib/meson/README b/contrib/meson/README
deleted file mode 100644 (file)
index 6641f64..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-This Meson project is provided with no guarantee and maintained by Dima Krasner <dima@dimakrasner.com>.
-
-It outputs one libzstd, either shared or static, depending on default_library.
-
-How to build
-============
-
-`cd` to this meson directory (`zstd/contrib/meson`) and type:
-
-    $ meson --buildtype=release --strip --prefix=/usr builddir
-    $ ninja             # to build
-    $ ninja install     # to install
diff --git a/contrib/meson/README.md b/contrib/meson/README.md
new file mode 100644 (file)
index 0000000..a2730fa
--- /dev/null
@@ -0,0 +1,31 @@
+This Meson project is provided with no guarantee and maintained
+by Dima Krasner <dima@dimakrasner.com>.
+
+It outputs one `libzstd`, either shared or static, depending on
+`default_library` option.
+
+How to build
+============
+
+`cd` to this meson directory (`zstd/contrib/meson`) and type:
+
+```sh
+meson --buildtype=release --strip --prefix=/usr 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 the build, use:
+
+```sh
+meson configure
+```
+
+See [man meson(1)](https://manpages.debian.org/testing/meson/meson.1.en.html).