summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2021-01-14 17:28:03 +0100
committerLaurenz <laurmaedje@gmail.com>2021-01-14 17:30:22 +0100
commit73b25bdad0f0dda66f0a73c8b980e0ddb1a59553 (patch)
tree307561099ae30c19a1a7515c0d3b65baed265b5e /tests/README.md
parentcfcb36b159e3f65aff8cbdac6b537b40c22507c0 (diff)
Move bracket function tests to integration 🚚
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/tests/README.md b/tests/README.md
index 429207a5..91bf8f49 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,10 +1,9 @@
# Tests
+Directory structure:
- `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).
+ a test passed or failed.
- `res`: Resource files used by tests.
- `png`: PNG files produced by tests.
- `pdf`: PDF files produced by tests.
@@ -13,3 +12,12 @@ The test files are split into three categories:
- `full`: Tests of full documents.
- `lang`: Tests for specific language features.
- `library`: Tests for specific library functions.
+
+To keep things small, please optimize the reference images:
+```bash
+# One image
+oxipng -o max tests/ref/image.png
+
+# All images
+oxipng -r -o max tests/ref/*
+```