History

Ahrimdon 1107670ba9 Add dependencies locally & include game files		2024-02-27 05:55:45 -05:00
..
educational_decoder	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00
images	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00
decompressor_errata.md	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00
README.md	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00
zstd_compression_format.md	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00
zstd_manual.html	Add dependencies locally & include game files	2024-02-27 05:55:45 -05:00

README.md

Zstandard Documentation

This directory contains material defining the Zstandard format, as well as detailed instructions to use zstd library.

zstd_manual.html : Documentation of zstd.h API, in html format. Unfortunately, Github doesn't display html files in parsed format, just as source code. For a readable display of html API documentation of latest release, use this link: https://raw.githack.com/facebook/zstd/release/doc/zstd_manual.html .

zstd_compression_format.md : This document defines the Zstandard compression format. Compliant decoders must adhere to this document, and compliant encoders must generate data that follows it.

Should you look for resources to develop your own port of Zstandard algorithm, you may find the following resources useful :

educational_decoder : This directory contains an implementation of a Zstandard decoder, compliant with the Zstandard compression format. It can be used, for example, to better understand the format, or as the basis for a separate implementation of Zstandard decoder.

decode_corpus : This tool, stored in /tests directory, is able to generate random valid frames, which is useful if you wish to test your decoder and verify it fully supports the specification.