59a7116cc2
benchfn used to rely on mem.h, and util, which in turn relied on platform.h. Using benchfn outside of zstd required to bring all these dependencies. Now, dependency is reduced to timefn only. This required to create a separate timefn from util, and rewrite benchfn and timefn to no longer need mem.h. Separating timefn from util has a wide effect accross the code base, as usage of time functions is widespread. A lot of build scripts had to be updated to also include timefn. |
||
|---|---|---|
| .. | ||
| educational_decoder | ||
| images | ||
| README.md | ||
| zstd_compression_format.md | ||
| zstd_manual.html | ||
README.md
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
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 ressources to develop your own port of Zstandard algorithm, you may find the following ressources 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 :
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.