robert/qoicodec
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create a readme, incl. instructions for test exec

Browse Source 
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.
This commit is contained in:
Robert Garrett
2025-10-14 13:23:43 -05:00
parent e2ba02f4d1
commit 5b3c58fad5
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md Normal file
View File

@@ -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.