]> git.ipfire.org Git - thirdparty/zlib-ng.git/commitdiff
Add utils/README.md
authorHans Kristian Rosbach <hk-git@circlestorm.org>
Tue, 9 Jun 2026 13:41:28 +0000 (15:41 +0200)
committerHans Kristian Rosbach <hk-github@circlestorm.org>
Wed, 10 Jun 2026 13:35:32 +0000 (15:35 +0200)
utils/README.md [new file with mode: 0644]

diff --git a/utils/README.md b/utils/README.md
new file mode 100644 (file)
index 0000000..366bd82
--- /dev/null
@@ -0,0 +1,13 @@
+# zlib-ng Utilities
+
+This directory contains utility programs and development tools for zlib-ng. These utilities help with compression testing and generating of internal tables.
+
+`minigzip` is in addition to being used for testing also popularly used as a simpler but faster alternative to `gzip`.
+
+## Files
+
+- `minigzip.c`: A lightweight implementation of the standard gzip compression and decompression tool.
+- `minideflate.c`: A basic demonstration program for testing raw deflate compression and decompression streams.
+- `makefixed.c`: Generates the static Huffman codes table used for fixed deflate blocks (inffixed_tbl.h).
+- `maketrees.c`: Generates the static tree tables and compile-time structures used for Huffman tree construction (trees_tbl.h).
+- `makecrct.c`: Generates the precomputed CRC-32 and CRC-32-Fold lookup tables used to accelerate checksum calculations (crc32_braid_tbl.h).