From cc8d0c3913595f8dd702817d57cc3933b966f781 Mon Sep 17 00:00:00 2001 From: Nicholas O'Leary Date: Sun, 11 Nov 2012 15:09:23 +0000 Subject: [PATCH] update readme --- tests/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/tests/README.md b/tests/README.md index 598640eb..02fc3a09 100644 --- a/tests/README.md +++ b/tests/README.md @@ -2,6 +2,9 @@ This is a regression test suite for the `PubSubClient` library. +It is a work-in-progress and is subject to complete refactoring as the whim takes +me. + Without a suitable arduino plugged in, the test suite will only check the example sketches compile cleanly against the library. @@ -15,16 +18,13 @@ test case is built, uploaded and then the tests run. ## Running -Without a suitable arduino plugged in, the test suite will only check the -example sketches compile cleanly against the library. - -With an arduino plugged in, each sketch that has a corresponding python -test case is built, uploaded and then the tests run. - -The test suite _does not_ run an MQTT server - it is assumed to be already running. +The test suite _does not_ run an MQTT server - it is assumed to be running already. $ python testsuite.py +A summary of activity is printed to the console. More comprehensive logs are written +to the `logs` directory. + ## What it does For each example sketch, `sketch.ino`, the suite looks for a matching test case