mirrors/zstd
0
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2024-12-03 22:56:44 +08:00
Code Issues Packages Projects Releases Wiki Activity
542c9dfcf8
zstd/doc
History
Yann Collet 542c9dfcf8 changed name frameParams into frameHeader 
ZSTD_frameParams => ZSTD_frameHeader
ZSTD_getFrameParams() -> ZSTD_getFrameHeader()

The new naming is more distinctive from ZSTD_frameParameters,
which is used during compression.

ZSTD_frameHeader is clearer in its intention to described frame header content.
It also implies we are decoding a ZSTD frame, hence we are at decoding stage.
2017-05-09 15:46:07 -07:00
..
educational_decoder Educational decoder polish updates 2017-03-23 14:33:38 -07:00
images updated dict graphs to 2D mode 2017-05-03 14:33:28 -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 name frameParams into frameHeader 2017-05-09 15:46:07 -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.