AuroraMiddleware/zstd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
a54c86cfc6
zstd/doc
History
Yann Collet a54c86cfc6 defined a minimum negative level 
which can be probed using new function ZSTD_minCLevel().

Also : redefined ZSTD_TARGETLENGTH_MIN/MAX for consistency

used the opportunity to bump version number to v1.3.6
2018-09-20 16:52:03 -07:00
..
educational_decoder last batch of header files changed to reflect new license (#825) 2017-08-31 12:20:50 -07:00
images removed unused imaged 2018-06-27 16:03:46 -07:00
README.md update doc/README.md on provided tools to test 3rd party implementations 2018-02-27 17:37:05 -08:00
zstd_compression_format.md spec clarification 2018-09-05 12:31:33 -07:00
zstd_manual.html defined a minimum negative level 2018-09-20 16:52:03 -07: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. 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 ressources to develop your own port of Zstandard algorithm, you may find the following ressources 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.