facebook
/
zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
zstd/doc
History
sen 698f261b35
[1.5.0] Deprecate some functions (#2582) 
* Add deprecated macro to zstd.h, mark certain functions as deprecated

* Remove ZSTD_compress.c dependencies on deprecated functions
 		2021-05-06 17:59:32 -04:00
..
educational_decoder [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
images added graph for ZSTD_compress_usingCDict() in v1.3.6 2018-10-04 14:39:11 -07:00
README.md Spelling (#1582) 2019-04-12 11:18:11 -07:00
zstd_compression_format.md Change year to 2021 for compression format file 2021-01-11 08:53:29 -05:00
zstd_manual.html [1.5.0] Deprecate some functions (#2582) 2021-05-06 17:59:32 -04: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.