aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst24
1 files changed, 21 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 6a00502..96a1aef 100644
--- a/README.rst
+++ b/README.rst
@@ -26,9 +26,27 @@ Contributing
Running Tests
-------------
-To run the MQTT integration tests, create a file ``kerbana_tests.toml``
-in the base directory with the variable ``MQTT_SERVER`` pointing to a
-valid mqtt server you can use.
+To run the MQTT integration tests, create a file ``kerbana_tests.yaml``
+in the base directory with at least the variable ``MQTT_SERVER``
+pointing to a valid mqtt server you can use, then run the tests with
+``KERBANA_CONFIG=kerbana_tests.yaml ./manage.py test``.
+
+The ``check`` script can be used to run the tests with the above setting
+and for other checks and common tasks, with the following subcommands:
+
+test
+ run the test suite
+coverage
+ run the test suite and print coverage data
+qa
+ run qa checks (code style etc.)
+static
+ run static analysis tests
+run
+ runs the development server
+devdb
+ initalizes the db and creates ad admin user (whose password needs to
+ be set manually afterwards)
License
-------