Skip to content

Commit d56702a

Browse files
committed
Modernize README using Markdown
Signed-off-by: Philippe Proulx <[email protected]>
1 parent 6fe5adb commit d56702a

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

README

-9
This file was deleted.

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
ctf-testsuite
2+
=============
3+
4+
The Common Trace Format (CTF) test suite is intended to validate the
5+
conformance of CTF readers.
6+
7+
To run the test suite:
8+
9+
1. Set the `CTF_READER_BIN` environment variable to your CTF reader
10+
executable, e.g.:
11+
12+
export CTF_READER_BIN=my-ctf-reader
13+
14+
2. Execute the `run.sh` script found in the `tests/x.y` directory,
15+
where `x.y` is the CTF specification's version you want to check,
16+
e.g.:
17+
18+
( cd tests/1.8 && ./run.sh )
19+
20+
You may also set the `CTF_READER_OPTS` environment variable to options
21+
to pass to the CTF reader defined by `CTF_READER_BIN`.

0 commit comments

Comments
 (0)