aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 44 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f0e4f1e
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+NAME
+ libquanta - Colour quantisation library
+
+SYNOPSIS
+ #include <libquanta.h>
+
+ Link with -lquanta.
+
+DESCRIPTION
+ The libquanta software library is a C library for colour
+ quantisation of images, meaning it lets you create a colour
+ palette for an image and convert the image to a palette-based
+ image.
+
+ The palette may have lower colour resolution and fewer colours
+ than the original image.
+
+ libquanta is not designed to convert an image to a
+ palette-based image based on a pre-existing palette. It is
+ only designed to create a palette suitable for a provided
+ image.
+
+ The libquanta software library implements the following
+ functions:
+
+ Colour palette functions
+ libquanta_palette_size(3)
+ Calculate the size of a colour palette.
+
+ libquanta_malloc_palette(3)
+ Allocate a colour palette.
+
+ Colour quantisation functions
+ libquanta_quantise(3),
+ libquanta_vquantise(3)
+ Colour-quantise an image using an algorithm selected
+ by the library.
+
+ libquanta_quantise_wu(3),
+ libquanta_vquantise_wu(3)
+ Colour-quantise an image using Wu's Colour Quantiser.
+
+SEE ALSO
+ None.