1*3117ece4SchristosZstandard Documentation 2*3117ece4Schristos======================= 3*3117ece4Schristos 4*3117ece4SchristosThis directory contains material defining the Zstandard format, 5*3117ece4Schristosas well as detailed instructions to use `zstd` library. 6*3117ece4Schristos 7*3117ece4Schristos__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format. 8*3117ece4SchristosUnfortunately, Github doesn't display `html` files in parsed format, just as source code. 9*3117ece4SchristosFor a readable display of html API documentation of latest release, 10*3117ece4Schristosuse 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*3117ece4Schristos 12*3117ece4Schristos__`zstd_compression_format.md`__ : This document defines the Zstandard compression format. 13*3117ece4SchristosCompliant decoders must adhere to this document, 14*3117ece4Schristosand compliant encoders must generate data that follows it. 15*3117ece4Schristos 16*3117ece4SchristosShould you look for resources to develop your own port of Zstandard algorithm, 17*3117ece4Schristosyou may find the following resources useful : 18*3117ece4Schristos 19*3117ece4Schristos__`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder, 20*3117ece4Schristoscompliant with the Zstandard compression format. 21*3117ece4SchristosIt can be used, for example, to better understand the format, 22*3117ece4Schristosor as the basis for a separate implementation of Zstandard decoder. 23*3117ece4Schristos 24*3117ece4Schristos[__`decode_corpus`__](https://github.com/facebook/zstd/tree/dev/tests#decodecorpus---tool-to-generate-zstandard-frames-for-decoder-testing) : 25*3117ece4SchristosThis tool, stored in `/tests` directory, is able to generate random valid frames, 26*3117ece4Schristoswhich is useful if you wish to test your decoder and verify it fully supports the specification. 27