zstd/doc
Yann Collet 394eec697b Introduce ZSTD_getFrameProgression()
Produces 3 statistics for ongoing frame compression :
- ingested
- consumed (effectively compressed)
- produced

Ingested can be larger than consumed due to buffering effect.

For the time being, this patch mostly fixes the % ratio issue,
since it computes consumed / produced,
instead of ingested / produced.

That being said, update is not "smooth",
because on a slow enough setting,
fileio spends most of its time waiting for a worker to complete its job.

This could be improved thanks to more granular flushing
i.e. start flushing before ongoing job is fully completed.
2018-01-17 16:39:02 -08:00
..
educational_decoder last batch of header files changed to reflect new license (#825) 2017-08-31 12:20:50 -07:00
images minor readme formatting update 2017-12-15 13:26:39 -08:00
README.md Move educational_decoder to doc/ and add doc README 2017-02-23 14:34:52 -08:00
zstd_compression_format.md fix unbounded range 2017-12-21 16:15:12 -08:00
zstd_manual.html Introduce ZSTD_getFrameProgression() 2018-01-17 16:39:02 -08:00

README.md

Zstandard Documentation

This directory contains material defining the Zstandard format, as well as for help using the zstd library.

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.

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 a Zstandard decoder/encoder.

zstd_manual.html : Documentation on the functions found in zstd.h. See http://zstd.net/zstd_manual.html for the manual released with the latest official zstd release.