Robert Garrett
5b3c58fad5
It's about time I have a README for this thing. I need somewhere to put the test setup instructions, making now as good a time as any to get around to it.
904 B
904 B
QOI Codec Crate
The Quite Okay Image format is an image compression scheme whose specification fits on one single page.
This crate is my (work in progress) implementation of that specification. At this time (v0.1) it can only decode some of the test images. Some don't work correctly and some don't work at all.
Running the tests
- Download the sample data set: https://qoiformat.org/qoi_test_images.zip
- Unpack them into the project folder at
./qoi_test_images/
The "integration test" in tests/codec.rs reads a QOI file and decodes it into a PNG. Since these images are not part of the repo, test will fail without this manual step.
Other tests, like those inside the regular source tree will run just fine. E.g.: The module crate::decoder::test will run properly with no additional setup actions. All data is contained as constants inside the source code.