Skip to content

Commit 1a7f3d7

Browse files
committed
Update readme build instructions
1 parent 7ce4378 commit 1a7f3d7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,21 @@ There are two main APIs:
1919
The compress/decompress APIs mirror that of lz4, while the streaming API was
2020
designed to be a drop-in replacement for zlib.
2121

22+
### Building against an external libzstd
23+
24+
By default, zstd source code is vendored in this repository and the binding will be built with
25+
the vendored source code bundled.
26+
27+
If you want to build this binding against an external static or shared libzstd library, you can
28+
use the `external_libzstd` build tag. This will look for the libzstd pkg-config file and extract
29+
build and linking parameters from that pkg-config file.
30+
31+
Note that it requires at least libzstd 1.4.0.
32+
33+
```bash
34+
go build -tags external_libzstd
35+
```
36+
2237
### Simple `Compress/Decompress`
2338

2439

0 commit comments

Comments
 (0)