Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
knolleary committed Nov 11, 2012
1 parent 50fc79d commit cc8d0c3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down

0 comments on commit cc8d0c3

Please sign in to comment.