summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2021-01-16 15:28:03 +0100
committerLaurenz <laurmaedje@gmail.com>2021-01-16 15:39:25 +0100
commitcc5f14193c25200e254e64cc594b15e84da280f9 (patch)
tree3659be64d81dc3c0b2b4b36dd70f1d9bb949fcb1 /tests/README.md
parent51efb0f4d69943e290d977673970cd3c8ada306f (diff)
Flip test directory structure 🔃
Move full/lang/library to the top-level as that's more ergonomic to use.
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/tests/README.md b/tests/README.md
index 91bf8f49..efca6dd6 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,23 +1,23 @@
# Tests
-Directory structure:
+Top level directory structure:
+- `full`: Tests of full documents.
+- `lang`: Tests for specific language features.
+- `library`: Tests for specific library functions.
+- `res`: Resource files used by tests.
+
+Directory structure for each category:
- `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.
- `png`: PNG files produced by tests.
- `pdf`: PDF files produced by tests.
-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
+oxipng -o max path/to/image.png
# All images
-oxipng -r -o max tests/ref/*
+oxipng -r -o max tests/*/ref
```