Eremey Valetov
7691dcc4fa
Sphinx docs with Furo theme covering CLI usage, library API reference, archive format specification, build instructions, history, and roadmap. GitHub Actions workflow deploys to Pages on push to main.
25 lines
482 B
ReStructuredText
25 lines
482 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 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
|