History

Nick Terrell 0f4fd28a64 Deprecate ZSTD_getDecompressedSize() (#3225 ) Fixes #3158. Mark ZSTD_getDecompressedSize() as deprecated and replaced by ZSTD_getFrameContentSize().		2022-08-01 11:52:14 -07:00
..
educational_decoder	Fix typos	2021-11-13 10:04:04 +02:00
images	Add transparency and optimize logo (#3218 )	2022-07-29 10:17:31 -07:00
README.md	Spelling (#1582 )	2019-04-12 11:18:11 -07:00
decompressor_errata.md	fix some typos	2022-04-26 17:40:23 +08:00
zstd_compression_format.md	fix small error in format documentation example	2022-05-24 04:47:49 -07:00
zstd_manual.html	Deprecate ZSTD_getDecompressedSize() (#3225 )	2022-08-01 11:52:14 -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 resources to develop your own port of Zstandard algorithm, you may find the following resources 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.