summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorClement Sibille <clements+git@lisible.xyz>2024-03-05 16:59:28 +0900
committerClement Sibille <clements+git@lisible.xyz>2024-03-05 16:59:28 +0900
commit964429c5755a83d3565d4729e1c7f41170e77b1a (patch)
treef8e22f25359cb2ebd7fb7e5929b25dcbd6093374 /README.md
parentbb6f08f3c79efc7bb7877aca97cebd3dab8b7838 (diff)
Add documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6eb528e..dad2d43 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
# LisiblePNG - a PNG decoder
This PNG decoder is meant to be used in my other C projects.
+
+## Supported features
+
+This is a simple implementation of a PNG decoder, it currently implements the following features:
+- Greyscale wihout alpha
+- Truecolour without alpha, without palette
+- 1 to 16 bit depth samples
+- All PNG filtering methods
+
+## Building
+
+```bash
+meson setup <builddir>
+meson compile -C <builddir>
+```
Go back to lisible.xyz