From e6e8c607c22565b591fc48585054c41ce92bdb4e Mon Sep 17 00:00:00 2001
From: Christopher Yeleighton <ne01026@shark.2a.pl>
Date: Thu, 29 Apr 2021 13:25:55 +0200
Subject: [PATCH] test/README: Improve wording, convert to markdown (#1662)

* test/README: Improve wording, convert to markdown
---
 tests/Makefile.am |  2 +-
 tests/README      | 36 ------------------------------------
 tests/README.md   | 37 +++++++++++++++++++++++++++++++++++++
 3 files changed, 38 insertions(+), 37 deletions(-)
 delete mode 100644 tests/README
 create mode 100644 tests/README.md

diff --git a/tests/Makefile.am b/tests/Makefile.am
index af10bb06f..5a5a1e742 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -3,7 +3,7 @@
 include $(top_srcdir)/rpm.am
 AM_CFLAGS = @RPMCFLAGS@
 
-EXTRA_DIST =
+EXTRA_DIST = README.md
 CLEANFILES =
 
 ##
diff --git a/tests/README b/tests/README
deleted file mode 100644
index c7423a30f..000000000
--- a/tests/README
+++ /dev/null
@@ -1,36 +0,0 @@
-To run these tests you need at least these dependencies on the host:
-
-    fakechroot (https://github.com/dex4er/fakechroot/wiki)
-    gdb (https://www.gnu.org/software/gdb/)
-    gnupg >= 2.0 (https://www.gnupg.org/)
-
-Then run
-
-   make check
-
-The number of tests performed depends on enabled features at configure-time,
-at least --with/without-lua and --enable/--disable-python.
-See also the INSTALL file for more information.
-
-To run single tests you can run
-
-   make populate_testing ; ./rpmtests NNN MMM ...
-
-where NNN and MMM are the numbers of the tests to be run. Use
-
-      ./rpmtests -l
-
-to get the list of available tests.
-You can also select tests by keywords used in their description by using
-
-     ./rpmtests -k KEYWORD
-
-Use multiple -k parameters to have tests with different keywords run.
-Use -k KEYWORD1,KEYWORD2 to execute tests matching both KEYWORD1 and KEYWORD2.
-
-See
-
-	./rpmtests --help
-
-for more options. But be aware some (like -j) may not work properly with
-the test suite unless a very restricted set of test is run.
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 000000000..b2b8860ac
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,37 @@
+To run these tests, you need at least these dependencies on the host:
+
+1.    [fakechroot](https://github.com/dex4er/fakechroot/wiki)
+1.    [gdb](https://www.gnu.org/software/gdb/)
+1.    [gnupg](https://www.gnupg.org/) >= 2.0
+
+Then run the command
+
+    make check
+
+The number of tests performed depends on features enabled at configure time,
+at least `--with-`/`--without-lua` and `--enable-`/`--disable-python`.
+See also the [INSTALL](../INSTALL) file for more information.
+
+To run *single tests*, you can run the commands:
+
+    make populate_testing && ./rpmtests $NNN $MMM ...
+
+where _NNN_ and _MMM_ are the numbers of the tests to be run.
+
+To get the *list of available tests*, use the command:
+
+      ./rpmtests -l
+
+You can also select *tests by keywords* used in their description by using the command:
+
+     ./rpmtests -k $KEYWORD
+
+Use multiple `-k` parameters to have tests with different keywords run.
+Use `-k $KEYWORD1,$KEYWORD2` to execute tests matching both _KEYWORD1_ and _KEYWORD2_.
+
+See the output of the command:
+
+	./rpmtests --help
+
+for more options. But be aware some (like `-j`) need not work properly with
+the test suite unless a very restricted set of test is run.