diff options
Diffstat (limited to 'tests/README.md')
| -rw-r--r-- | tests/README.md | 13 |
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. + |