From 98cf7fcb2ab311dc40a616cd15774813e1e8517d Mon Sep 17 00:00:00 2001 From: Sean Purcell Date: Tue, 18 Apr 2017 17:03:37 -0700 Subject: [PATCH] Update README --- lib/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/README.md b/lib/README.md index 3357e3d87..8fa60a20f 100644 --- a/lib/README.md +++ b/lib/README.md @@ -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. 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 -- 2.47.2