summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2020-12-17 11:31:07 +0100
committerLaurenz <laurmaedje@gmail.com>2020-12-17 11:31:07 +0100
commit0adbfe894ae1252758d1d7fff1df5514824347eb (patch)
tree8a3211ce0eb428cb49a71d85f03ff5b1a5354f81 /tests/README.md
parent81e80ecfba80f5bffab45719c1f2aba4f9b91b4f (diff)
Test [pagebreak] 🗞
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/tests/README.md b/tests/README.md
index 7d9c3eda..424c97d8 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,7 +1,10 @@
# Tests
-- `typ`: Input files
-- `ref`: Reference images which the output is compared with to determine
- whether a test passed or failed
-- `res`: Resource files used by tests
-- `out`: PNG and PDF files produced by tests
+- `typ`: Input files.
+- `ref`: Reference images which the output is compared with to determine whether
+ a test passed or failed. To keep things small, please run
+ `oxipng -o max tests/ref/<img>` when creating or updating reference
+ images (note that `<img>` can be `*` to optimize all images).
+- `res`: Resource files used by tests.
+- `out`: PNG and PDF files produced by tests.
+