Skip to content

Commit

Permalink
Mention library in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dstien committed Jan 5, 2024
1 parent 232b472 commit b9cf086
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a full list of options run `stunpack -h`.
The project can be compiled with the GNU toolchain by running `make`. Building for other targets can be achieved by setting a compiler/linker in the `CC` environment variable:
* Win32 with MinGW: `CC=i686-w64-mingw32-gcc make`
* Win64 with MinGW: `CC=x86_64-w64-mingw32-gcc make`
* MS DOS with Open Watcom: `CC=wcl386 INCLUDE=$WATCOM/h LIB=$WATCOM/lib386 PATH=$WATCOM/binl:$WATCOM/binw:$PATH make`
* MS DOS with Open Watcom: `CC=wcl386 AR=wlink INCLUDE=$WATCOM/h LIB=$WATCOM/lib386 PATH=$WATCOM/binl:$WATCOM/binw:$PATH make`
* Any target exposed by Zig's Clang interface: `CC="zig cc -target riscv64-linux-musl" make`

Variables that affects the build process:
Expand All @@ -35,6 +35,10 @@ Variables that affects the build process:
* `EXESUFFIX`: Defaults to `.exe` if a Windows or DOS compiler is detected
* `INSTALLDIR`: Defaults to `/usr/local/bin` for `make install`

## Library

The code for handling the compression formats is separated from the command line utility in a static library located in `src/lib`. The header file is `include/stunpack.h`.

## Additional documentation

The data format, compression algorithms and applied optimisations are described in the [Stunts Wiki](https://wiki.stunts.hu/wiki/Compression).
Expand Down

0 comments on commit b9cf086

Please sign in to comment.