[atkmm: 1/2] Convert README to MD
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atkmm: 1/2] Convert README to MD
- Date: Sun, 15 May 2022 14:54:14 +0000 (UTC)
commit 4564fb3e2f0f71a1f1c52a8a2b0b8f94feea4dd6
Author: Doomsdayrs <doomsdayrs gmail com>
Date: Tue May 10 20:03:32 2022 +0000
Convert README to MD
README => README.md | 35 ++++++++++++++++++++++++++---------
1 file changed, 26 insertions(+), 9 deletions(-)
---
diff --git a/README b/README.md
similarity index 95%
rename from README
rename to README.md
index 8e4adee..4e58a27 100644
--- a/README
+++ b/README.md
@@ -1,3 +1,4 @@
+# atkmm
atkmm is the C++ binding for the ATK library.
This module is part of the GNOME C++ bindings effort <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 atkmm-@ATKMM_VERSION tar xz
$ cd atkmm-@ATKMM_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,28 +31,35 @@ 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
@@ -65,20 +75,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
-
+```
+ $ 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]