Add README for using auto tests

As running the unit tests requires a specific setup, this should be
documented.

Change-Id: Ia9059e6590c54bd232842fc02a4dc91dd630f48f
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>

1 files changed, 21 insertions, 0 deletions

diff --git a/tests/README.txt b/tests/README.txt
new file mode 100644
index 0000000..3a8bf51
--- /dev/null
+++ b/tests/README.txt
@@ -0,0 +1,21 @@
+The tests included in the subdirectories check for functionality and
+conformance of the Qt MQTT module.
+
+To be able to run the tests successfully, a broker needs to be available and
+reachable.
+
+The continuous integration utilized the paho conformance test broker. It can
+be obtained at this location:
+https://github.com/eclipse/paho.mqtt.testing
+
+For the unit tests being able to locate this script, use the
+MQTT_TEST_BROKER_LOCATION environment variable and set it
+to “<install-path>/interoperability/startbroker.py”.
+
+Alternatively, any broker can be instantiated and passed to the auto tests
+by using the environment variable MQTT_TEST_BROKER. This must point to a
+valid url. The broker must run on the standardized port 1883.
+
+Note, that the unit tests verify functionality against the MQTT 3.1.1 version
+of the standard, hence the broker needs to be compliant to the adherent
+specifications.