a880ca239b
* spelling: accidentally * spelling: across * spelling: additionally * spelling: addresses * spelling: appropriate * spelling: assumed * spelling: available * spelling: builder * spelling: capacity * spelling: compiler * spelling: compressibility * spelling: compressor * spelling: compression * spelling: contract * spelling: convenience * spelling: decompress * spelling: description * spelling: deflate * spelling: deterministically * spelling: dictionary * spelling: display * spelling: eliminate * spelling: preemptively * spelling: exclude * spelling: failure * spelling: independence * spelling: independent * spelling: intentionally * spelling: matching * spelling: maximum * spelling: meaning * spelling: mishandled * spelling: memory * spelling: occasionally * spelling: occurrence * spelling: official * spelling: offsets * spelling: original * spelling: output * spelling: overflow * spelling: overridden * spelling: parameter * spelling: performance * spelling: probability * spelling: receives * spelling: redundant * spelling: recompression * spelling: resources * spelling: sanity * spelling: segment * spelling: series * spelling: specified * spelling: specify * spelling: subtracted * spelling: successful * spelling: return * spelling: translation * spelling: update * spelling: unrelated * spelling: useless * spelling: variables * spelling: variety * spelling: verbatim * spelling: verification * spelling: visited * spelling: warming * spelling: workers * spelling: with
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
Zstandard Documentation
|
|
=======================
|
|
|
|
This directory contains material defining the Zstandard format,
|
|
as well as detailed instructions to use `zstd` library.
|
|
|
|
__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format.
|
|
Click on this link: [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html)
|
|
to display documentation of latest release in readable format within a browser.
|
|
|
|
__`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
|
|
Compliant decoders must adhere to this document,
|
|
and compliant encoders must generate data that follows it.
|
|
|
|
Should you look for resources to develop your own port of Zstandard algorithm,
|
|
you may find the following resources useful :
|
|
|
|
__`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder,
|
|
compliant with the Zstandard compression format.
|
|
It can be used, for example, to better understand the format,
|
|
or as the basis for a separate implementation of Zstandard decoder.
|
|
|
|
[__`decode_corpus`__](https://github.com/facebook/zstd/tree/dev/tests#decodecorpus---tool-to-generate-zstandard-frames-for-decoder-testing) :
|
|
This tool, stored in `/tests` directory, is able to generate random valid frames,
|
|
which is useful if you wish to test your decoder and verify it fully supports the specification.
|