X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=README.md;h=52fabe8623555118610bdd978a0d407ad7a13dd3;hb=0f8beba86ae551f42adeb81d1bfddd5645f31013;hp=b8b057e62a47b2e968a8023dc3f28a375f8b22b7;hpb=343f803ef6c5965e0df282a255d02357287d7eb7;p=ctf-testsuite.git

diff --git a/README.md b/README.md
index b8b057e..52fabe8 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
 ctf-testsuite
 =============
 
-The Common Trace Format (CTF) testsuite is intended to validate the conformance of CTF readers.
\ No newline at end of file
+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`.