zstd/doc
Yann Collet ecf1778e23 updated ZSTD_format_e value validation
also updated manual
2017-09-27 11:19:21 -07:00
..
educational_decoder last batch of header files changed to reflect new license (#825) 2017-08-31 12:20:50 -07:00
images Add ldm documentation in README 2017-09-06 15:21:01 -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 formulation change, recommended by @ulikunitz 2017-08-20 10:39:20 -07:00
zstd_manual.html updated ZSTD_format_e value validation 2017-09-27 11:19:21 -07:00

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.