From c200c1d1dfa9046b271b426439a1454f56ba39d4 Mon Sep 17 00:00:00 2001
From: Philip Withnall <withnall@endlessm.com>
Date: Fri, 15 Jun 2018 12:26:18 +0100
Subject: [PATCH] docs: Rename README.in to README.md for GitLab

There seems to be little point in substituting the version number into
README (using autotools). Rename it to README.md and distribute that
verbatim (with autotools and Meson) instead.

Autotools still requires that README exists, so leave a stub README file
in place which redirects people to README.md. This can be dropped when
we drop autotools support.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
---
 .gitignore             | 1 -
 AUTHORS                | 4 ++--
 Makefile.am            | 3 +--
 README                 | 1 +
 README.in => README.md | 2 +-
 autogen.sh             | 8 ++++----
 configure.ac           | 1 -
 sanity_check           | 2 +-
 8 files changed, 10 insertions(+), 12 deletions(-)
 create mode 100644 README
 rename README.in => README.md (99%)

diff --git a/.gitignore b/.gitignore
index d390fd084..0caa0c05d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -51,7 +51,6 @@ py-compile
 test-driver
 
 INSTALL
-README
 ChangeLog
 /glib-lcov.info
 /glib-lcov/
diff --git a/AUTHORS b/AUTHORS
index 17814caa1..16884db81 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,7 +1,7 @@
 Below are just a few of the people who have contributed
 to GLib. Please don't mail these people about problems you
-have with GTK+; see the README file for information about
-filing bugs and submitting patches.
+have with GLib; see the README.md file for information about
+filing bugs and submitting changes.
 
 GLib-2.0 Team
 -------------
diff --git a/Makefile.am b/Makefile.am
index 284d39590..7de8c8ec9 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -38,7 +38,7 @@ EXTRA_DIST += 			\
 	acglib.m4		\
 	sanity_check		\
 	README.commits		\
-	README.in		\
+	README.md		\
 	README.rationale	\
 	INSTALL.in		\
 	README.win32		\
@@ -110,7 +110,6 @@ EXTRA_DIST += $(meson_build_files)
 
 # These may be in the builddir too
 BUILT_EXTRA_DIST += 		\
-	README			\
 	INSTALL			\
 	ChangeLog		\
 	$(NULL)
diff --git a/README b/README
new file mode 100644
index 000000000..96dc92fbd
--- /dev/null
+++ b/README
@@ -0,0 +1 @@
+See README.md
diff --git a/README.in b/README.md
similarity index 99%
rename from README.in
rename to README.md
index c178ccc1f..677f2dd86 100644
--- a/README.in
+++ b/README.md
@@ -1,7 +1,7 @@
 General Information
 ===================
 
-This is GLib version @GLIB_VERSION@. GLib is the low-level core
+GLib is the low-level core
 library that forms the basis for projects such as GTK+ and GNOME. It
 provides data structure handling for C, portability wrappers, and
 interfaces for such runtime functionality as an event loop, threads,
diff --git a/autogen.sh b/autogen.sh
index 4bbc00d98..9e4ba4c39 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -25,10 +25,10 @@ if test -z $AUTORECONF; then
         exit 1
 fi
 
-# README and INSTALL are required by automake, but may be deleted by clean
-# up rules. to get automake to work, simply touch these here, they will be
-# regenerated from their corresponding *.in files by ./configure anyway.
-touch README INSTALL
+# INSTALL is required by automake, but may be deleted by clean
+# up rules. to get automake to work, simply touch it here. It will be
+# regenerated from its corresponding *.in file by ./configure anyway.
+touch INSTALL
 
 autoreconf --force --install --verbose || exit $?
 
diff --git a/configure.ac b/configure.ac
index 9a5075aef..afbf34edb 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3520,7 +3520,6 @@ chmod 0755 gobject/glib-mkenums])
 if false; then
   AC_CONFIG_FILES([
     INSTALL
-    README
     glib/glib.rc
     gmodule/gmodule.rc
     gobject/gobject.rc
diff --git a/sanity_check b/sanity_check
index 5f6e66e20..44ae7f1f3 100755
--- a/sanity_check
+++ b/sanity_check
@@ -13,7 +13,7 @@ echo "Checking glib-$VERSION.tar.gz..."
 tar xfz glib-$VERSION.tar.gz
 
 
-for file in INSTALL NEWS README 
+for file in INSTALL NEWS
 do
 	echo -n "$file... "
 	if [ "x`grep $VERSION glib-$VERSION/$file | wc -l | awk -F' ' '{print $1}'`" = "x0" ]; then