sys/contrib/zstd/doc/README.md

   1 Zstandard Documentation
   2 =======================
   3
   4 This directory contains material defining the Zstandard format,
   5 as well as for help using the `zstd` library.
   6
   7 __`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
   8 Compliant decoders must adhere to this document,
   9 and compliant encoders must generate data that follows it.
  10
  11 __`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder,
  12 compliant with the Zstandard compression format.
  13 It can be used, for example, to better understand the format,
  14 or as the basis for a separate implementation a Zstandard decoder/encoder.
  15
  16 __`zstd_manual.html`__ : Documentation on the functions found in `zstd.h`.
  17 See [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html) for
  18 the manual released with the latest official `zstd` release.
  19
  20