lib/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-08-01 09:47:01 +03:00
Code Activity

Move educational_decoder to doc/ and add doc README

Browse Source 
- Also make some minor bugfixes to educational decoder
This commit is contained in:
Sean Purcell
2017-02-23 14:34:52 -08:00
parent a395fdbaf0
commit 1d1932480e
5 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/educational_decoder/README.md Normal file
View File

@ -0,0 +1,19 @@
Educational Decoder
===================
`zstd_decompress.c` is a self-contained implementation in C99 of a decoder,
according to the [Zstandard format specification].
While it does not implement as many features as the reference decoder,
such as the streaming API or content checksums, it is written to be easy to
follow and understand, to help understand how the Zstandard format works.
It's laid out to match the [format specification],
so it can be used to understand how complex segments could be implemented.
It also contains implementations of Huffman and FSE table decoding.
[Zstandard format specification]: https://github.com/facebook/zstd/blob/dev/doc/zstd_compression_format.md
[format specification]: https://github.com/facebook/zstd/blob/dev/doc/zstd_compression_format.md
`harness.c` provides a simple test harness around the decoder:
harness <input-file> <output-file> [dictionary]