zstd/doc
Nick Terrell 5f2c7213c7 Merge remote-tracking branch 'upstream/dev' into btopt
* upstream/dev: (305 commits)
  added test for ZSTD_estimateCStreamSize()
  changed variable name, for clarity
  fixed ZSTD_estimateCStreamSize()
  shortened ZSTD_createCStream_Advanced()
  fixed symbols test
  added ZSTD_estimateDStreamSize()
  changed name frameParams into frameHeader
  regroup memory usage function declarations
  separated ZSTD_estimateCStreamSize() from ZSTD_estimateCCtxSize()
  bumped version number
  added ZSTD_estimateCDictSize() and ZSTD_estimateDDictSize()
  Updated ZSTD_freeCCtx()
  updated ZSTD_estimateCCtxSize()
  Updated ZSTD_sizeof_CCtx()
  merged CCtx and CStream as a single same object
  cli : -d and -t do not stop after a failed decompression
  added dev branch CircleCI badge
  added dev branch Appveyor badge
  keep dev branch status only
  creates a binary archive without the `programs` directory
  ...
2017-05-10 16:49:58 -07:00
..
educational_decoder Educational decoder polish updates 2017-03-23 14:33:38 -07:00
images updated dict graphs to 2D mode 2017-05-03 14:33:28 -07:00
README.md Move educational_decoder to doc/ and add doc README 2017-02-23 14:34:52 -08:00
zstd_compression_format.md minor typo fixes in specification 2017-03-31 16:19:04 -07:00
zstd_manual.html Merge remote-tracking branch 'upstream/dev' into btopt 2017-05-10 16:49:58 -07:00

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.