Files
uc2/docs/quickstart.rst
Eremey Valetov a30c8cf694 Add archive creation with SuperMaster compression
CLI: uc2 -w [-L level] archive.uc2 files...
Creates UC2 archives with long filename tags and the built-in 49KB
SuperMaster dictionary for improved compression via LZ77 prefix matching.

Library: uc2_compress_ex() accepts master data to pre-fill the sliding
window and hash chains. uc2_get_supermaster() decompresses the embedded
super.bin. uc2_compress() unchanged (backward compatible, NoMaster).

Tests: 5 SuperMaster roundtrip tests, CLI create/extract CTest script.
2026-03-12 02:04:13 -04:00

27 lines
602 B
ReStructuredText

Quick Start
===========
Building
--------
Requires CMake >= 3.16 and a C99 compiler (GCC, Clang, or MSVC).
.. code-block:: sh
cmake -B build
cmake --build build
The binary is at ``build/cli/uc2``.
Basic Usage
-----------
.. code-block:: sh
uc2 -w archive.uc2 file1 file2 # Create archive
uc2 archive.uc2 # Extract all files
uc2 -l archive.uc2 # List contents
uc2 -t archive.uc2 # Test archive integrity
uc2 -d /tmp/out archive.uc2 # Extract to directory
uc2 -w -L 5 big.uc2 data/* # Create with Ultra compression