ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Sean Purcell
2017-04-18 17:03:37 -07:00
parent ca6fae7808
commit 98cf7fcb2a
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/README.md
+8
View File
@@ -22,6 +22,14 @@ Some additional API may be useful if you're looking into advanced features :
They are not "stable", their definition may change in the future. They are not "stable", their definition may change in the future.
Only static linking is allowed. Only static linking is allowed.
#### ZSTDMT API
To enable building the multithreaded compression API, use the `make lib-mt` target.
The header file zstdmt_compress.h (in compress/) provides the prototypes for the API.
If linking a program that uses the ZSTDMT API against libzstd.a on a POSIX system,
the -pthread flag must be provided to the compiler at link time.
Note that these prototypes may still be used in a version built without multithread support,
but they will be single threaded (i.e. no benefits will be given over the standard ZSTD API).
#### Modular build #### Modular build