[pangomm] Convert README to README.md
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pangomm] Convert README to README.md
- Date: Mon, 12 Sep 2022 15:01:20 +0000 (UTC)
commit dcc05d8a0ffa4ce257e0196a857a3a8db11a1de5
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Mon Sep 12 16:56:55 2022 +0200
Convert README to README.md
README => README.md | 37 ++++++++++++++++++++++++++++---------
1 file changed, 28 insertions(+), 9 deletions(-)
---
diff --git a/README b/README.md
similarity index 90%
rename from README
rename to README.md
index c41fec2..26109b9 100644
--- a/README
+++ b/README.md
@@ -1,3 +1,4 @@
+# pangomm
This is pangomm, a C++ API for Pango.
See http://www.gtkmm.org/
@@ -13,8 +14,10 @@ See README.win32
## Building from a release tarball
Extract the tarball and go to the extracted directory:
+```
$ tar xf pangomm-@PANGOMM_VERSION tar xz
$ cd pangomm-@PANGOMM_VERSION@
+```
It's easiest to build with Meson, if the tarball was made with Meson,
and to build with Autotools, if the tarball was made with Autotools.
@@ -28,36 +31,45 @@ of untracked/.
Don't call the builddir 'build'. There is a directory called 'build' with
files used by Autotools.
-
+```
$ meson --prefix /some_directory --libdir lib your_builddir .
$ cd your_builddir
-
+```
If the tarball was made with Autotools, you must enable maintainer-mode:
+```
$ meson configure -Dmaintainer-mode=true
+```
Then, regardless of how the tarball was made:
+```
$ ninja
$ ninja install
-
+```
### Building from a tarball with Autotools
If the tarball was made with Autotools:
+```
$ ./configure --prefix=/some_directory
+```
If the tarball was made with Meson, you must enable maintainer-mode:
+```
$ ./autogen.sh --prefix=/some_directory
+```
Then, regardless of how the tarball was made:
+```
$ make
$ make install
-
+```
## Building from git
Building from git can be difficult so you should prefer building from
a release tarball unless you need to work on the pangomm code itself.
jhbuild can be a good help
- https://gitlab.gnome.org/GNOME/jhbuild
- https://wiki.gnome.org/Projects/Jhbuild
+- https://gitlab.gnome.org/GNOME/jhbuild
+- https://wiki.gnome.org/Projects/Jhbuild
+- https://gnome.pages.gitlab.gnome.org/jhbuild
### Building from git with Meson
@@ -65,20 +77,27 @@ Maintainer-mode is enabled by default when you build from a git clone.
Don't call the builddir 'build'. There is a directory called 'build' with
files used by Autotools.
-
+```
$ meson --prefix /some_directory --libdir lib your_builddir .
$ cd your_builddir
$ ninja
$ ninja install
+```
You can create a tarball like so:
+```
$ ninja dist
-
+```
### Building from git with Autotools
-
+```
$ ./autogen.sh --prefix=/some_directory
$ make
$ make install
+```
You can create a tarball like so:
+```
$ make distcheck
+```
or
+```
$ make dist
+```
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]