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>
This commit is contained in:
Philip Withnall 2018-06-15 12:26:18 +01:00
parent 8e65417c6e
commit c200c1d1df
8 changed files with 10 additions and 12 deletions

1
.gitignore vendored
View File

@ -51,7 +51,6 @@ py-compile
test-driver test-driver
INSTALL INSTALL
README
ChangeLog ChangeLog
/glib-lcov.info /glib-lcov.info
/glib-lcov/ /glib-lcov/

View File

@ -1,7 +1,7 @@
Below are just a few of the people who have contributed Below are just a few of the people who have contributed
to GLib. Please don't mail these people about problems you to GLib. Please don't mail these people about problems you
have with GTK+; see the README file for information about have with GLib; see the README.md file for information about
filing bugs and submitting patches. filing bugs and submitting changes.
GLib-2.0 Team GLib-2.0 Team
------------- -------------

View File

@ -38,7 +38,7 @@ EXTRA_DIST += \
acglib.m4 \ acglib.m4 \
sanity_check \ sanity_check \
README.commits \ README.commits \
README.in \ README.md \
README.rationale \ README.rationale \
INSTALL.in \ INSTALL.in \
README.win32 \ README.win32 \
@ -110,7 +110,6 @@ EXTRA_DIST += $(meson_build_files)
# These may be in the builddir too # These may be in the builddir too
BUILT_EXTRA_DIST += \ BUILT_EXTRA_DIST += \
README \
INSTALL \ INSTALL \
ChangeLog \ ChangeLog \
$(NULL) $(NULL)

1
README Normal file
View File

@ -0,0 +1 @@
See README.md

View File

@ -1,7 +1,7 @@
General Information 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 library that forms the basis for projects such as GTK+ and GNOME. It
provides data structure handling for C, portability wrappers, and provides data structure handling for C, portability wrappers, and
interfaces for such runtime functionality as an event loop, threads, interfaces for such runtime functionality as an event loop, threads,

View File

@ -25,10 +25,10 @@ if test -z $AUTORECONF; then
exit 1 exit 1
fi fi
# README and INSTALL are required by automake, but may be deleted by clean # INSTALL is required by automake, but may be deleted by clean
# up rules. to get automake to work, simply touch these here, they will be # up rules. to get automake to work, simply touch it here. It will be
# regenerated from their corresponding *.in files by ./configure anyway. # regenerated from its corresponding *.in file by ./configure anyway.
touch README INSTALL touch INSTALL
autoreconf --force --install --verbose || exit $? autoreconf --force --install --verbose || exit $?

View File

@ -3520,7 +3520,6 @@ chmod 0755 gobject/glib-mkenums])
if false; then if false; then
AC_CONFIG_FILES([ AC_CONFIG_FILES([
INSTALL INSTALL
README
glib/glib.rc glib/glib.rc
gmodule/gmodule.rc gmodule/gmodule.rc
gobject/gobject.rc gobject/gobject.rc

View File

@ -13,7 +13,7 @@ echo "Checking glib-$VERSION.tar.gz..."
tar xfz glib-$VERSION.tar.gz tar xfz glib-$VERSION.tar.gz
for file in INSTALL NEWS README for file in INSTALL NEWS
do do
echo -n "$file... " echo -n "$file... "
if [ "x`grep $VERSION glib-$VERSION/$file | wc -l | awk -F' ' '{print $1}'`" = "x0" ]; then if [ "x`grep $VERSION glib-$VERSION/$file | wc -l | awk -F' ' '{print $1}'`" = "x0" ]; then