add a readme

This commit is contained in:
2025-09-07 22:40:06 -05:00
parent ba8acc79f3
commit 32179abb48
8 changed files with 27 additions and 6 deletions

9
README.md Normal file
View File

@@ -0,0 +1,9 @@
# QOI for Allegro
This is a simple liballeg plugin that gives Allegro the ability to decode QOI images, in both 24-bit and 32-bit formats.
Some example images and a test program are provided. All of the code is in allegro_qoi.c. The header file declares only a single function `al_init_qoi()` which takes no parameters (same thing as `al_init_image_addon()`). Call it once when your program starts.
If you want you can also just drop the `allegro_qoi.c` into your project and forward-declare it's init function once where it's used.
This plugin does not handle saving QOI images yet.