From 99d9758d90a88b92fc8fcdb447aa7ab4abe1c1cb Mon Sep 17 00:00:00 2001
From: Simon McVittie <smcv@collabora.com>
Date: Wed, 3 Oct 2018 16:30:04 +0100
Subject: [PATCH] Use Markdown for documentation

Signed-off-by: Simon McVittie <smcv@collabora.com>
---
 CONTRIBUTING => CONTRIBUTING.md |  0
 Makefile.am                     |  4 ++--
 README => README.md             | 18 ++++++++++--------
 3 files changed, 12 insertions(+), 10 deletions(-)
 rename CONTRIBUTING => CONTRIBUTING.md (100%)
 rename README => README.md (77%)

diff --git a/CONTRIBUTING b/CONTRIBUTING.md
similarity index 100%
rename from CONTRIBUTING
rename to CONTRIBUTING.md
diff --git a/Makefile.am b/Makefile.am
index cc46f6e9..3e60286d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,8 +1,8 @@
 EXTRA_DIST = \
 	AUTHORS \
-	CONTRIBUTING \
+	CONTRIBUTING.md \
 	COPYING \
-	README \
+	README.md \
 	$(NULL)
 
 AM_CPPFLAGS = \
diff --git a/README b/README.md
similarity index 77%
rename from README
rename to README.md
index ee14484a..8f401618 100644
--- a/README
+++ b/README.md
@@ -24,26 +24,28 @@ dbus-gmain requires GLib >= 2.40. This can be reduced to 2.32, or
 probably older, if you don't build the tests.
 
 If you use the included Makefile.am (which requires building the tests),
-you must check for libdbus via pkg-config using the prefix "DBUS", check
+you must check for libdbus via pkg-config using the prefix `DBUS`, check
 for GLib (and optionally gobject and gio) via pkg-config using the prefix
-"GLIB", and check for DBUS_RUN_SESSION for the tests:
+`GLIB`, and check for `DBUS_RUN_SESSION` for the tests:
 
+```
 PKG_CHECK_MODULES([DBUS], [dbus-1 >= 1.8])
 PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.40])
 AC_ARG_VAR([DBUS_RUN_SESSION],
   [The dbus-run-session tool from dbus 1.8 or later])
 AC_PATH_PROG([DBUS_RUN_SESSION], [dbus-run-session], [dbus-run-session])
+```
 
 Alternatively, you can include dbus-gmain.[ch] among the source files for
 some executable or library.
 
-By default, dbus-gmain declares its functions in the dbus_gmain_*
-namespace. To change this, define DBUS_GMAIN_FUNCTION_NAME(name) to
+By default, dbus-gmain declares its functions in the `dbus_gmain_`\*
+namespace. To change this, define `DBUS_GMAIN_FUNCTION_NAME(name)` to
 a suitably prefixed or suffixed version of name. The default is
-"dbus_gmain_ ## name".
+`dbus_gmain_ ## name`.
 
-By default, dbus-gmain declares its functions G_GNUC_INTERNAL, so they
+By default, dbus-gmain declares its functions `G_GNUC_INTERNAL`, so they
 will not be part of your library's ABI on supported compilers. To change
-this (not recommended), define DBUS_GMAIN_FUNCTION(ret, name, ...) to
+this (not recommended), define `DBUS_GMAIN_FUNCTION(ret, name, ...)` to
 a form that includes suitable decorators. The default is
-"G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)".
+`G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)`.
-- 
GitLab