summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaulo Zanoni <paulo.r.zanoni@intel.com>2019-04-17 17:47:55 -0700
committerKenneth Graunke <kenneth@whitecape.org>2019-04-23 16:19:05 -0700
commit276cb4c555114198f09627ae41cc3d7adbeb5ed9 (patch)
tree8a9a309619fe76c697cbb81b23fe2c5c525e00c6 /README.md
parent6bf8ddb48480bc2cd1d2b56294e0ea32be971a56 (diff)
README.md: fix the formatting for the main sections
When reading README.md on the gitlab web page, the main sections are shown as small unlinkable text, while subsections work fine. On Vim, they are not bold and colored as the subsections. Use Markdown for the main sections too so we get pretty linkable html output and also bold red on Vim. Signed-off-by: Paulo Zanoni <paulo.r.zanoni@intel.com> Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 6 insertions, 12 deletions
diff --git a/README.md b/README.md
index c75c5f6c3..311c7c75c 100644
--- a/README.md
+++ b/README.md
@@ -10,8 +10,7 @@ Piglit
6. Todo
-1. About
---------
+## 1. About
Piglit is a collection of automated tests for OpenGL and OpenCL
implementations.
@@ -25,8 +24,7 @@ The original tests have been taken from
- Mesa ( http://www.mesa3d.org/ )
-2. Setup
---------
+## 2. Setup
First of all, you need to make sure that the following are installed:
@@ -188,8 +186,7 @@ CD to piglit directory.
cmake -H. -Bbuild -G "Ninja" -DGLEXT_INCLUDE_DIR=\path\to\glext -DPIGLIT_USE_WAFFLE=TRUE -DWAFFLE_INCLUDE_DIRS=\path\to\waffle\include\waffle WAFFLE_LDFLAGS=\path\to\waffle\lib\libwaffle-1.a
-3. How to run tests
--------------------
+## 3. How to run tests
Make sure that everything is set up correctly:
@@ -314,8 +311,7 @@ source the file on startup. If piglit is installed and bash-completions are
available, then this completion file will be installed system-wide.
-4. Available test sets
-----------------------
+## 4. Available test sets
Test sets are specified as Python scripts in the tests directory.
The following test sets are currently available:
@@ -377,8 +373,7 @@ The following test sets are currently available:
suite with piglit.
-5. How to write tests
----------------------
+## 5. How to write tests
Every test is run as a separate process. This minimizes the impact that
severe bugs like memory corruption have on the testing process.
@@ -432,8 +427,7 @@ python framework:
function to search directories for tests.
-6. Integration
---------------
+## 6. Integration
Piglit provides integration for other test suites as well. The rational for
this is that it provides piglit's one process per test protections (one test