README.md
1Zstandard Documentation
2=======================
3
4This directory contains material defining the Zstandard format,
5as well as detailed instructions to use `zstd` library.
6
7__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format.
8Click on this link: [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html)
9to display documentation of latest release in readable format within a browser.
10
11__`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
12Compliant decoders must adhere to this document,
13and compliant encoders must generate data that follows it.
14
15Should you look for resources to develop your own port of Zstandard algorithm,
16you may find the following resources useful :
17
18__`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder,
19compliant with the Zstandard compression format.
20It can be used, for example, to better understand the format,
21or as the basis for a separate implementation of Zstandard decoder.
22
23[__`decode_corpus`__](https://github.com/facebook/zstd/tree/dev/tests#decodecorpus---tool-to-generate-zstandard-frames-for-decoder-testing) :
24This tool, stored in `/tests` directory, is able to generate random valid frames,
25which is useful if you wish to test your decoder and verify it fully supports the specification.
26