xref: /freebsd/sys/contrib/zstd/doc/README.md (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
1Zstandard Documentation
2=======================
3
4This directory contains material defining the Zstandard format,
5as well as for help using the `zstd` library.
6
7__`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
8Compliant decoders must adhere to this document,
9and compliant encoders must generate data that follows it.
10
11__`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder,
12compliant with the Zstandard compression format.
13It can be used, for example, to better understand the format,
14or as the basis for a separate implementation a Zstandard decoder/encoder.
15
16__`zstd_manual.html`__ : Documentation on the functions found in `zstd.h`.
17See [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html) for
18the manual released with the latest official `zstd` release.
19
20
21