History

Peter (Stig) Edwards 2ff9249810 -Wformat-security not needed with -Wformat=2		2019-02-01 09:27:22 +00:00
..
educational_decoder	-Wformat-security not needed with -Wformat=2	2019-02-01 09:27:22 +00:00
images	added graph for ZSTD_compress_usingCDict() in v1.3.6	2018-10-04 14:39:11 -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	minor clarifications of history update rules	2018-10-26 15:51:51 -07:00
zstd_manual.html	fixed minor conversion warnings in examples/	2019-01-19 23:38:20 -08: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.