summaryrefslogtreecommitdiffstats
path: root/libraries/libavif/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/libavif/README')
-rw-r--r--libraries/libavif/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/libraries/libavif/README b/libraries/libavif/README
index c51c31dd2b..ae08322017 100644
--- a/libraries/libavif/README
+++ b/libraries/libavif/README
@@ -1,3 +1,24 @@
This library aims to be a portable C implementation of
AV1 image file format.It can encode and decode all AOM
supported YUV formats and bit depths.
+
+It builds an decoder avifdec and encoder avifenc.
+avifdec can convert from avif to jpeg or png image.
+avifenc can encode jpeg or png to avif image.
+
+usage:
+-------
+
+avifdec [-options] input.avif output.jpeg|jpeg|png|y4m
+
+avifdec -h will show help
+
+avifenc [-options] input.jpg|jpeg|png|y4m output.avif
+
+avifenc -h will show help
+
+Note For 32-bit users:
+-----------------------
+
+Pandoc is an optional dependency since man pages
+are disabled by default for 32-bit users.