update readme
This commit is contained in:
parent
50fc79dc42
commit
cc8d0c3913
@ -2,6 +2,9 @@
|
|||||||
|
|
||||||
This is a regression test suite for the `PubSubClient` library.
|
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
|
Without a suitable arduino plugged in, the test suite will only check the
|
||||||
example sketches compile cleanly against the library.
|
example sketches compile cleanly against the library.
|
||||||
|
|
||||||
@ -15,16 +18,13 @@ test case is built, uploaded and then the tests run.
|
|||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
Without a suitable arduino plugged in, the test suite will only check the
|
The test suite _does not_ run an MQTT server - it is assumed to be running already.
|
||||||
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.
|
|
||||||
|
|
||||||
$ python testsuite.py
|
$ python testsuite.py
|
||||||
|
|
||||||
|
A summary of activity is printed to the console. More comprehensive logs are written
|
||||||
|
to the `logs` directory.
|
||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
For each example sketch, `sketch.ino`, the suite looks for a matching test case
|
For each example sketch, `sketch.ino`, the suite looks for a matching test case
|
||||||
|
Loading…
x
Reference in New Issue
Block a user