summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2017-10-14 18:42:57 +0300
committerLars Wirzenius <liw@liw.fi>2017-10-14 18:42:57 +0300
commit8fe6b206ac462f45e2394fcad9f1101a7067e653 (patch)
treede986d99789f3b1d32e981ca2c450d036173135f /README
parentd043647934a89501111c46d586be407ea503c87c (diff)
downloadick2-8fe6b206ac462f45e2394fcad9f1101a7067e653.tar.gz
Add: update README about ./check changes
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 19 insertions, 2 deletions
diff --git a/README b/README
index f80e6c3..cbcf349 100644
--- a/README
+++ b/README
@@ -19,8 +19,25 @@ Ick2 is written in Python 2 (do not ask for Python 3, it will happen
when it happens).
There are some unit and integration tests written for the controller's
-HTTP API. To run them, run `./check`. You may add any command line
-parameters than `yarn` accepts.
+HTTP API. The integration tests can start a local instance of the
+controller; either of the following works:
+
+ ./check
+ ./check local
+
+You can add any command line parameters `yarn` accepts, but you have
+to specify `local` explicitly:
+
+ ./check local -v --tempdir tmp --snapshot
+
+You can also run the integration tests against an existing remote
+setup:
+
+ ./check https://ick-controller
+ ./check https://ick-controller -v --tempdir tmp --snapshot
+
+Please make sure at least the local `./check` passes with your
+changes, before submitting them.
Running