lib/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-07-29 11:21:22 +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

20
doc/README.md Normal file
View File

@ -0,0 +1,20 @@
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](http://zstd.net/zstd_manual.html) for
the manual released with the latest official `zstd` release.