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
This commit is contained in:
Thomas Haller
2022-03-17 11:22:05 +01:00
parent 85ceffceb9
commit 1c76c11b42
4 changed files with 9 additions and 2 deletions

View File

@@ -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 \

View File

View File

@@ -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])

View File

@@ -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