summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpommicket <pommicket@gmail.com>2023-09-05 22:10:51 -0400
committerpommicket <pommicket@gmail.com>2023-09-05 22:10:51 -0400
commit40b2894ae4ade5461469aaa337862a586d16eac6 (patch)
tree4180e2072f9e9a6299f0ae2f7abcf4c1fa538d46 /README.md
parent6d9d77638172a50c1fa349f8f81ed5a951e4716b (diff)
better tests, caught some bugs
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 551251e..c1f9380 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ Also it has tiny code size (e.g. &gt;8 times smaller `.wasm.gz` size compared to
- Checking block CRCs (increases code complexity
and there’s already Adler32 checksums for IDAT chunks)
- ancillary chunks (tEXt, iCCP, etc.)
+- correctly handling non-indexed image with tRNS chunk (who uses this?)
## Example usage
@@ -61,6 +62,12 @@ A `pre-commit` git hook is provided to run `cargo fmt` and `cargo clippy`. You c
ln -s ../../pre-commit .git/hooks/
```
+## Testing
+
+All PNG files in the `test` directory are tested by `cargo t` (NOTE: `cargo test`
+doesn‘t log as much progress because there’s no way of dynamically generating
+tests and no way of enabling `--nocapture` by default *grumble grumble*).
+
## Performance
Benchmarks (see `cargo bench`) show that `tiny-png` is about 50% slower than `png`
@@ -81,4 +88,3 @@ for large images, but faster than `png` for small images.
> AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
> OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-(Note: all the test PNG images are either in the U.S. public domain or CC0-licensed.)