summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKjell Ahlstedt <kjellahlstedt@gmail.com>2020-03-25 11:03:18 +0100
committerKjell Ahlstedt <kjellahlstedt@gmail.com>2020-03-25 11:03:18 +0100
commit2acde6c77a781120551881f20c8340a66c225ac3 (patch)
treef189ed73e4c69500daa8c61641965d11e0e5a44e /README.md
parent754a114176bfcd9b34c8b86cad6c0badb0f77e38 (diff)
downloadsigc++-2acde6c77a781120551881f20c8340a66c225ac3.tar.gz
README.md: Better describe when maintainer-mode is necessary
As a libsigc++-3 tarball does not contain generated source code, maintainer-mode is not always necessary when you build with Meson from a tarball that was created by Autotools.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 159eb3a..ecbb21f 100644
--- a/README.md
+++ b/README.md
@@ -48,12 +48,14 @@ files used by Autotools.
For instance:
```sh
-# If the tarball was made with Autotools, you must enable maintainer-mode:
+# If the tarball was made with Autotools, and you want to rebuild the reference
+# documentation, you must enable maintainer-mode:
$ meson --prefix=/usr/local --libdir=lib -Dmaintainer-mode=true your_builddir .
-# If the tarball was made with Meson:
+
+# If the tarball was made with Meson, or you don't want to rebuild the docs:
$ meson --prefix=/usr/local --libdir=lib your_builddir .
-# then
+# then:
$ cd your_builddir
$ ninja
$ ninja install
@@ -67,10 +69,11 @@ For instance:
```sh
# If the tarball was made with Autotools:
$ ./configure --prefix=/usr/local
+
# If the tarball was made with Meson, you must enable maintainer-mode:
$ ./autogen.sh --prefix=/usr/local
-# then
+# then:
$ make
$ make install
# You can build the examples and tests, and run the tests, like so: