updated lib/README.md

This commit is contained in:
inikep 2016-04-25 11:31:28 +02:00
parent f066816998
commit 49794316c2

View File

@ -5,53 +5,58 @@ The __lib__ directory contains several files, but depending on target use case,
#### Minimal library files #### Minimal library files
##### Shared ressources To build the zstd library the following files are required:
- [mem.h](mem.h) - [common/bitstream.h](common/bitstream.h)
- [error_private.h](error_private.h) - [common/error_private.h](common/error_private.h)
- [error_public.h](error_public.h) - [common/error_public.h](common/error_public.h)
- common/fse.h
##### zstd core compression - common/fse_static.h
- common/huf.h
- common/huf_static.h
- [common/mem.h](common/mem.h)
- [common/zstd.h](common/zstd.h)
- common/zstd_internal.h
- common/zstd_static.h
- compress/fse_compress.c
- compress/huf_compress.c
- compress/zstd_compress.c
- compress/zstd_opt.h
- decompress/fse_decompress.c
- decompress/huf_decompress.c
- decompress/zstd_decompress.c
Stable API is exposed in [zstd.h]. Stable API is exposed in [zstd.h].
Advanced and experimental API is exposed in `zstd_static.h`. Advanced and experimental API is exposed in `zstd_static.h`.
`zstd_static.h` API elements should be used with static linking only, `zstd_static.h` API elements should be used with static linking only,
as their definition may change in future version of the library. as their definition may change in future version of the library.
- [bitstream.h](bitstream.h)
- fse.c
- fse.h
- fse_static.h
- huf.c
- huf.h
- huf_static.h
- zstd_compress.c
- zstd_decompress.c
- zstd_internal.h
- zstd_opt.h
- [zstd.h]
- zstd_static.h
[zstd.h]: zstd.h #### Separate compressor and decompressor
To build a separate zstd compressor all files from common/ and compressor/ directories are required.
In similar way to build a separate zstd decompressor all files from common/ and decompressor/ directories are needed.
#### 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, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) : It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) :
- zbuff.c - common/zbuff.h
- zbuff.h - common/zbuff_static.h
- zbuff_static.h - compress/zbuff_compress.c
- decompress/zbuff_decompress.c
#### Dictionary builder #### Dictionary builder
To create dictionaries from training sets : To create dictionaries from training sets :
- divsufsort.c - dictBuilder/divsufsort.c
- divsufsort.h - dictBuilder/divsufsort.h
- zdict.c - dictBuilder/zdict.c
- zdict.h - dictBuilder/zdict.h
- zdict_static.h - dictBuilder/zdict_static.h
#### Miscellaneous #### Miscellaneous