10c16b537SWarner LoshZstandard Documentation 20c16b537SWarner Losh======================= 30c16b537SWarner Losh 40c16b537SWarner LoshThis directory contains material defining the Zstandard format, 519fcbaf1SConrad Meyeras well as detailed instructions to use `zstd` library. 619fcbaf1SConrad Meyer 719fcbaf1SConrad Meyer__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format. 819fcbaf1SConrad MeyerClick on this link: [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html) 919fcbaf1SConrad Meyerto display documentation of latest release in readable format within a browser. 100c16b537SWarner Losh 110c16b537SWarner Losh__`zstd_compression_format.md`__ : This document defines the Zstandard compression format. 120c16b537SWarner LoshCompliant decoders must adhere to this document, 130c16b537SWarner Loshand compliant encoders must generate data that follows it. 140c16b537SWarner Losh 15*2b9c00cbSConrad MeyerShould you look for resources to develop your own port of Zstandard algorithm, 16*2b9c00cbSConrad Meyeryou may find the following resources useful : 1719fcbaf1SConrad Meyer 180c16b537SWarner Losh__`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder, 190c16b537SWarner Loshcompliant with the Zstandard compression format. 200c16b537SWarner LoshIt can be used, for example, to better understand the format, 2119fcbaf1SConrad Meyeror as the basis for a separate implementation of Zstandard decoder. 220c16b537SWarner Losh 2319fcbaf1SConrad Meyer[__`decode_corpus`__](https://github.com/facebook/zstd/tree/dev/tests#decodecorpus---tool-to-generate-zstandard-frames-for-decoder-testing) : 2419fcbaf1SConrad MeyerThis tool, stored in `/tests` directory, is able to generate random valid frames, 2519fcbaf1SConrad Meyerwhich is useful if you wish to test your decoder and verify it fully supports the specification. 26