summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPovilas Kanapickas <povilas@radix.lt>2021-02-08 02:39:03 +0200
committerPovilas Kanapickas <povilas@radix.lt>2021-02-08 02:39:03 +0200
commit1fb6ba1a4f0743b77abbcb676b358563cd899c99 (patch)
treee0a7a18f593b57b56defa1d8a27984f3baa18e0a
parent8925a86be753b95d453c0f4faeb6195671193295 (diff)
README: Use markdown syntax for headings
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index c1f63aa..cd9889f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
This is a test suite for X.Org tests.
-== Building the code ==
+Building the code
+=================
```
$ meson builddir
@@ -9,7 +10,9 @@ $ ninja -C builddir
This project relies on the xorg-gtest repo which is enabled as a submodule.
-== Running the tests ==
+Running the tests
+=================
+
Tests can be run by `ninja -C builddir test`, or one-by-one.
Most tests start up some X server, so it is advisable to shut down any X
@@ -20,7 +23,9 @@ advisable to shut down any X server on the test box.
For controlling test output (e.g. xml reporting), refer to
http://code.google.com/p/googletest/wiki/AdvancedGuide#Controlling_Test_Output
-== Debugging test failures ==
+Debugging test failures
+=======================
+
To run a subset of tests within a test case, filter on the test name. For
example,
@@ -37,5 +42,7 @@ allows to investigate logs or attach gdb to the server process.
For further environment variables please refer to the xorg-gtest README
http://gitlab.freedesktop.org/xorg/test/xorg-gtest/
-== Writing tests ==
+Writing tests
+=============
+
Please refer to the HACKING document