summaryrefslogtreecommitdiffstats
path: root/tests/ui/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/ui/README.md')
-rw-r--r--tests/ui/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/tests/ui/README.md b/tests/ui/README.md
new file mode 100644
index 00000000..4cbe40ac
--- /dev/null
+++ b/tests/ui/README.md
@@ -0,0 +1,13 @@
+# UI testing
+
+This crate is just a helper crate for CI runs and development. It contains
+test code which tests the actual imag binaries and their user interfaces and
+behaviour.
+
+Tests are automatically done in temporary directories.
+The test setup removes these testing directories after tests have run.
+To prevent this, set `IMAG_UI_TEST_PERSIST`.
+
+Use the normal `RUST_LOG` functionality for logging (or see the documentation
+for the `env_logger` crate).
+