From d56702a02905f562b15e13d056e4e00f40bad8c9 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 Nov 2014 18:37:44 -0500 Subject: [PATCH] Modernize README using Markdown Signed-off-by: Philippe Proulx --- README | 9 --------- README.md | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 9 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 52b8fa2..0000000 --- a/README +++ /dev/null @@ -1,9 +0,0 @@ -ctf-testsuite -============= - -The Common Trace Format (CTF) testsuite is intended to validate the -conformance of CTF readers. - -To run the testsuite simply export CTF_READER_BIN="$YOUR_CTF_READER" and -use the run.sh script found in the tests/x.y/ folder, x.y being the CTF -specification version you want to check. diff --git a/README.md b/README.md new file mode 100644 index 0000000..52fabe8 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +ctf-testsuite +============= + +The Common Trace Format (CTF) test suite is intended to validate the +conformance of CTF readers. + +To run the test suite: + + 1. Set the `CTF_READER_BIN` environment variable to your CTF reader + executable, e.g.: + + export CTF_READER_BIN=my-ctf-reader + + 2. Execute the `run.sh` script found in the `tests/x.y` directory, + where `x.y` is the CTF specification's version you want to check, + e.g.: + + ( cd tests/1.8 && ./run.sh ) + +You may also set the `CTF_READER_OPTS` environment variable to options +to pass to the CTF reader defined by `CTF_READER_BIN`. -- 2.34.1