From 2f5e345fc08641d0a9b4c35aaa8ff9825f1a7482 Mon Sep 17 00:00:00 2001 From: Kjell Ahlstedt Date: Mon, 12 Sep 2022 16:03:39 +0200 Subject: Convert README to README.md --- README | 92 ---------------------------------------------- README.md | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 124 insertions(+), 92 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index f13cd66a..00000000 --- a/README +++ /dev/null @@ -1,92 +0,0 @@ -This is glibmm, a C++ API for parts of glib that are useful for C++. -See http://www.gtkmm.org - -# Building - -Whenever possible, you should use the official binary packages approved by the -supplier of your operating system, such as your Linux distribution. - -## Building on Windows - -See README.win32 - -## Building from a release tarball - -Extract the tarball and go to the extracted directory: - $ tar xf glibmm-@GLIBMM_VERSION@.tar.xz - $ cd glibmm-@GLIBMM_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. -Then you don't have to use maintainer-mode. - -How do you know how the tarball was made? If it was made with Meson, -it contains files in untracked/glib/glibmm/, untracked/gio/giomm/ and -other subdirectories of untracked/. - -### Building from a tarball with Meson - -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 -You can run the tests like so: - $ ninja test - -### 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 -You can build the examples and tests, and run the tests, like so: - $ make check - -## 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 glibmm code itself. - -jhbuild can be a good help - https://gitlab.gnome.org/GNOME/jhbuild - https://wiki.gnome.org/Projects/Jhbuild - -### Building from git with Meson - -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 run the tests like so: - $ ninja test -You can create a tarball like so: - $ ninja dist - -### Building from git with Autotools - - $ ./autogen.sh --prefix=/some_directory - $ make - $ make install -You can build the examples and tests, and run the tests, like so: - $ make check -You can create a tarball like so: - $ make distcheck -or - $ make dist diff --git a/README.md b/README.md new file mode 100644 index 00000000..c3d5e47d --- /dev/null +++ b/README.md @@ -0,0 +1,124 @@ +# glibmm +This is glibmm, a C++ API for parts of glib that are useful for C++. +See http://www.gtkmm.org + +# Building + +Whenever possible, you should use the official binary packages approved by the +supplier of your operating system, such as your Linux distribution. + +## Building on Windows + +See README.win32 + +## Building from a release tarball + +Extract the tarball and go to the extracted directory: +``` + $ tar xf glibmm-@GLIBMM_VERSION@.tar.xz + $ cd glibmm-@GLIBMM_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. +Then you don't have to use maintainer-mode. + +How do you know how the tarball was made? If it was made with Meson, +it contains files in untracked/glib/glibmm/, untracked/gio/giomm/ and +other subdirectories of untracked/. + +### Building from a tarball with Meson + +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 +``` +You can run the tests like so: +``` + $ ninja test +``` + +### 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 +``` +You can build the examples and tests, and run the tests, like so: +``` + $ make check +``` + +## 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 glibmm code itself. + +jhbuild can be a good help +- https://gitlab.gnome.org/GNOME/jhbuild +- https://wiki.gnome.org/Projects/Jhbuild +- https://gnome.pages.gitlab.gnome.org/jhbuild + +### Building from git with Meson + +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 run the tests like so: +``` + $ ninja test +``` +You can create a tarball like so: +``` + $ ninja dist +``` + +### Building from git with Autotools + +``` + $ ./autogen.sh --prefix=/some_directory + $ make + $ make install +``` +You can build the examples and tests, and run the tests, like so: +``` + $ make check +``` +You can create a tarball like so: +``` + $ make distcheck +``` +or +``` + $ make dist +``` -- cgit v1.2.1