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