zstd/doc
Yann Collet 768df129d2 changed ZSTD_compressBegin_usingCDict()
No longer takes `pledgedSrcSize` as argument
this is in line with similar functions ZSTD_compress_usingCDict()
and ZSTD_initCStream_usingCDict().
2017-04-26 15:42:10 -07:00
..
educational_decoder Educational decoder polish updates 2017-03-23 14:33:38 -07:00
images updated compression graph 2017-03-17 14:25:57 -07:00
README.md Move educational_decoder to doc/ and add doc README 2017-02-23 14:34:52 -08:00
zstd_compression_format.md minor typo fixes in specification 2017-03-31 16:19:04 -07:00
zstd_manual.html changed ZSTD_compressBegin_usingCDict() 2017-04-26 15:42:10 -07:00

README.md

Zstandard Documentation

This directory contains material defining the Zstandard format, as well as for help using the zstd library.

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.

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 a Zstandard decoder/encoder.

zstd_manual.html : Documentation on the functions found in zstd.h. See http://zstd.net/zstd_manual.html for the manual released with the latest official zstd release.