mirror of
https://github.com/facebook/zstd.git
synced 2024-12-04 07:37:34 +08:00
updated README following merging of *_static.h
This commit is contained in:
parent
a91ca620cf
commit
51778b7cca
@ -12,27 +12,22 @@ To build the zstd library the following files are required:
|
||||
- [common/error_public.h](common/error_public.h)
|
||||
- common/fse.h
|
||||
- common/fse_decompress.c
|
||||
- common/fse_static.h
|
||||
- common/huf.h
|
||||
- common/huf_static.h
|
||||
- [common/mem.h](common/mem.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
|
||||
- compress/zstd_opt.h
|
||||
- decompress/huf_decompress.c
|
||||
- decompress/zstd_decompress.c
|
||||
|
||||
Stable API is exposed in [common/zstd.h].
|
||||
Advanced and experimental API is exposed in [common/zstd_static.h].
|
||||
API elements of [common/zstd_static.h] should be used with static linking only,
|
||||
as their definition may change in future version of the library.
|
||||
Advanced and experimental API can be enabled by defining `ZSTD_STATIC_LINKING_ONLY`.
|
||||
Never use them with a dynamic library, as their definition may change in future versions.
|
||||
|
||||
[common/zstd.h]: common/zstd.h
|
||||
[common/zstd_static.h]: common/zstd_static.h
|
||||
|
||||
|
||||
#### Separate compressor and decompressor
|
||||
@ -47,7 +42,6 @@ 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) :
|
||||
|
||||
- common/zbuff.h
|
||||
- common/zbuff_static.h
|
||||
- compress/zbuff_compress.c
|
||||
- decompress/zbuff_decompress.c
|
||||
|
||||
@ -59,7 +53,6 @@ To create dictionaries from training sets :
|
||||
- dictBuilder/divsufsort.h
|
||||
- dictBuilder/zdict.c
|
||||
- dictBuilder/zdict.h
|
||||
- dictBuilder/zdict_static.h
|
||||
|
||||
#### Miscellaneous
|
||||
|
||||
@ -68,4 +61,3 @@ The other files are not source code. There are :
|
||||
- LICENSE : contains the BSD license text
|
||||
- Makefile : script to compile or install zstd library (static or dynamic)
|
||||
- libzstd.pc.in : for pkg-config (make install)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user