Convert README to README.md

kjellahl · kjellahl · commit 93f1d31bbe3d · 2022-09-13T14:42:32.000+02:00
diff --git a/README.md b/README.md
@@ -1,24 +1,23 @@
-libxml++
---------
-
+# libxml++
 libxml++ (a.k.a. libxmlplusplus) provides a C++ interface to XML files. It uses
 libxml2 to access the XML files, and in order to configure libxml++ you must
 have both libxml2 and pkg-config installed.
 
-To get the latest version of libxml++, see
-https://libxmlplusplus.github.io/libxmlplusplus/
-To contact the developers, send e-mail to the mailing list at
-http://mail.gnome.org/mailman/listinfo/libxmlplusplus-list
-We welcome patches, but it helps to discuss them first.
+To get the latest version of libxml++, see the
+[libxml++ web site](https://libxmlplusplus.github.io/libxmlplusplus/)
+
+To contact the developers, send e-mail to the
+[libxml++ mailing list](https://mail.gnome.org/mailman/listinfo/libxmlplusplus-list)
 
 See the examples directory for example code.
 
 Use pkg-config to discover the necessary include and linker arguments. For instance,
+```
   pkg-config libxml++-4.0 --cflags --libs
+```
 If you build with Autotools, ideally you would use PKG_CHECK_MODULES in your
 configure.ac file.
 
-
 # Building
 
 Whenever possible, you should use the official binary packages approved by the
@@ -31,8 +30,10 @@ See MSVC_NMake/README
 ## Building from a release tarball
 
 Extract the tarball and go to the extracted directory:
+```
   $ tar xf libxml++-@LIBXMLXX_VERSION@.tar.xz
   $ cd libxml++-@LIBXMLXX_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.
@@ -46,65 +47,90 @@ 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
+```
 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 libxml++ 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
 
 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
+```
