zstd/doc
2020-11-04 11:37:37 +00:00
..
educational_decoder Fix copyright and license lines 2020-03-26 17:02:06 -07:00
images added graph for ZSTD_compress_usingCDict() in v1.3.6 2018-10-04 14:39:11 -07:00
README.md Spelling (#1582) 2019-04-12 11:18:11 -07:00
zstd_compression_format.md Updated to repcode documentation to reflect dict content size 2020-09-22 13:24:27 -04:00
zstd_manual.html Add ZSTD_getDictID_fromCDict function to experimental section 2020-11-04 11:37:37 +00:00

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. Click on this link: http://zstd.net/zstd_manual.html to display documentation of latest release in readable format within a browser.

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.