From 5b3c58fad502e9b48fae7b7890cf7363fe7f2bb1 Mon Sep 17 00:00:00 2001 From: Robert Garrett Date: Tue, 14 Oct 2025 13:23:43 -0500 Subject: [PATCH] Create a readme, incl. instructions for test exec 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. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b96a280 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# QOI Codec Crate + +The [Quite Okay Image format](https://qoiformat.org/) 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 + +1. Download the sample data set: https://qoiformat.org/qoi_test_images.zip +2. 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.