Add: links to ick, yarn, how to run check

1 files changed, 35 insertions, 2 deletions

diff --git a/yarns/000.yarn b/yarns/000.yarn
index 39022bf..d5db1a1 100644
--- a/yarns/000.yarn
+++ b/yarns/000.yarn
@@ -26,5 +26,38 @@ version: work in progress
 
 # Introduction
 
-This is a set of integration tests for Ick2, a continuous integration
-system. Written for execution by yarn.
+This is a set of integration tests for [Ick2][], a continuous integration
+system. Written for execution by [yarn][].
+
+[Ick2]: http://ick.liw.fi/
+[yarn]: https://liw.fi/cmdtest/
+
+## Running this test suite
+
+This test suite tests an Ick2 controller, and can either run in a
+local or remote mode. In local mode, each test scenario starts and
+stops a local instance, and runs tests against that. In remote mode,
+an existing, running controller instance is assumed, and tests are run
+against that.
+
+The `./check` script runs the tests. By default it runs in local mode.
+Local mode can be specified explicitly with the `local` parameter:
+
+    EXAMPLE running the test suite in local mode
+    ./check
+    ./check local
+    ./check local -v --tempdir tmp --snapshot
+
+`./check` can be given extra arguments, which it will pass on to
+`yarn`.
+
+To run the tests in remote mode, give the controller URL:
+
+    EXAMPLE running the test suite in local mode
+    ./check https://ick-controller --env ICK_PRIVATE_KEY=~/tmp/ick.key
+    ./check https://ick-controller --env ICK_PRIVATE_KEY=~/tmp/ick.key \
+        -v --tempdir tmp --snapshot
+
+The URL **must** be an `https` URL. Additionally, the environment
+variable `ICK_PRIVATE_KEY` must be given a path to the *private* key
+for signing tokens, so that a new token can be generated.