facebook
/
zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor doc clarifications

dev
Yann Collet 2016-03-10 01:09:41 +01:00
parent e3193c4081
commit dcc000f0eb
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/README.md
View File

@ -13,6 +13,11 @@ The __lib__ directory contains several files, but depending on target use case,
##### zstd core compression ##### zstd core compression
Stable API is exposed in [zstd.h].
Advanced and experimental API is exposed in `zstd_static.h`.
`zstd_static.h` API elements should be used with static linking only,
as their definition may change in future version of the library.
- [bitstream.h](bitstream.h) - [bitstream.h](bitstream.h)
- fse.c - fse.c
- fse.h - fse.h
@ -24,13 +29,15 @@ The __lib__ directory contains several files, but depending on target use case,
- zstd_decompress.c - zstd_decompress.c
- zstd_internal.h - zstd_internal.h
- zstd_opt.h - zstd_opt.h
- zstd.h - [zstd.h]
- zstd_static.h - zstd_static.h
[zstd.h]: zstd.h
#### Buffered streaming #### Buffered streaming
This complementary API makes streaming integration easier. This complementary API makes streaming integration easier.
It is used by `zstd` command line utility : It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) :
- zbuff.c - zbuff.c
- zbuff.h - zbuff.h