From 1c76c11b4200400b99d9075fbdd43a9d5738b1d4 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Thu, 17 Mar 2022 11:22:05 +0100 Subject: [PATCH] doc: rename "README" to "README.md" By having a ".md" extension, gitlab renders a nice page instead of showing as plain text. Currently our README is pretty bad. Partly, because it doesn't get shown nicely. Rename. The file effectively was already markdown. The old file is gone. For this we also need to change the automake flavor to "foreign" (See [1]). [1] https://autotools.info/automake/options.html#automake.options.flavors --- Makefile.am | 7 +++++++ README => README.md | 0 configure.ac | 2 +- contrib/fedora/rpm/NetworkManager.spec | 2 +- 4 files changed, 9 insertions(+), 2 deletions(-) rename README => README.md (100%) diff --git a/Makefile.am b/Makefile.am index 4d9c4e7a7f..760b46b97a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -5578,6 +5578,13 @@ plugin_LTLIBRARIES += $(core_plugins) TESTS += $(check_programs) EXTRA_DIST += \ + \ + AUTHORS \ + COPYING \ + ChangeLog \ + NEWS \ + README.md \ + \ CONTRIBUTING.md \ COPYING.LGPL \ COPYING.GFDL \ diff --git a/README b/README.md similarity index 100% rename from README rename to README.md diff --git a/configure.ac b/configure.ac index 3874a5d5ba..42441a6525 100644 --- a/configure.ac +++ b/configure.ac @@ -21,7 +21,7 @@ AC_CONFIG_MACRO_DIR([m4]) AC_CONFIG_AUX_DIR([build-aux]) AC_REQUIRE_AUX_FILE([tap-driver.sh]) -AM_INIT_AUTOMAKE(1.12 tar-ustar no-dist-gzip dist-xz -Wno-portability) dnl NB: Do not [quote] this parameter. +AM_INIT_AUTOMAKE(1.12 foreign tar-ustar no-dist-gzip dist-xz -Wno-portability) dnl NB: Do not [quote] this parameter. AM_MAINTAINER_MODE([enable]) AM_SILENT_RULES([yes]) diff --git a/contrib/fedora/rpm/NetworkManager.spec b/contrib/fedora/rpm/NetworkManager.spec index 2aac3396b4..50d5d31ae8 100644 --- a/contrib/fedora/rpm/NetworkManager.spec +++ b/contrib/fedora/rpm/NetworkManager.spec @@ -1092,7 +1092,7 @@ fi %{_unitdir}/nm-priv-helper.service %dir %{_datadir}/doc/NetworkManager/examples %{_datadir}/doc/NetworkManager/examples/server.conf -%doc NEWS AUTHORS README CONTRIBUTING.md +%doc NEWS AUTHORS README.md CONTRIBUTING.md %license COPYING %license COPYING.LGPL %license COPYING.GFDL