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