summaryrefslogtreecommitdiff
path: root/system/zopfli/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/zopfli/README')
-rw-r--r--system/zopfli/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/system/zopfli/README b/system/zopfli/README
new file mode 100644
index 0000000000..1bdf00f886
--- /dev/null
+++ b/system/zopfli/README
@@ -0,0 +1,18 @@
+Zopfli Compression Algorithm is a compression library programmed in C to perform
+very good, but slow, deflate or zlib compression.
+
+The basic function to compress data is ZopfliCompress in zopfli.h. Use the
+ZopfliOptions object to set parameters that affect the speed and compression.
+Use the ZopfliInitOptions function to place the default values in the
+ZopfliOptions first.
+
+ZopfliCompress supports deflate, gzip and zlib output format with a parameter.
+To support only one individual format, you can instead use ZopfliDeflate in
+deflate.h, ZopfliZlibCompress in zlib_container.h or ZopfliGzipCompress in
+gzip_container.h.
+
+This library can only compress, not decompress. Existing zlib or deflate
+libraries can decompress the data.
+
+Zopfli Compression Algorithm was created by Lode Vandevenne and Jyrki
+Alakuijala, based on an algorithm by Jyrki Alakuijala.