]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
lib\README.md: added Using MinGW+MSYS to create DLL
authorPrzemyslaw Skibinski <inikep@gmail.com>
Mon, 21 Nov 2016 13:22:08 +0000 (14:22 +0100)
committerPrzemyslaw Skibinski <inikep@gmail.com>
Mon, 21 Nov 2016 13:22:08 +0000 (14:22 +0100)
lib/README.md
lib/dll/example/README.md

index d321f06b35db7a4ca1246e5def697c93dc70be67..d33ad52c2775a64066fa4310dfb41be72fb33af9 100644 (file)
@@ -43,6 +43,22 @@ Other optional functionalities provided are :
               For example, advanced API for version `v0.4` is in `legacy/zstd_v04.h` .
 
 
+#### Using MinGW+MSYS to create DLL
+
+DLL can be created using MinGW+MSYS with the `make libzstd` command.
+This command creates `dll\libzstd.dll` and the import library `dll\libzstd.lib`.
+The import library is only required with Visual C++.
+The header file `zstd.h` and the dynamic library `dll\libzstd.dll` are required to
+compile a project using gcc/MinGW.
+The dynamic library has to be added to linking options.
+It means that if a project that uses ZSTD consists of a single `test-dll.c`
+file it should be linked with `dll\libzstd.dll`. For example:
+```
+    gcc $(CFLAGS) -Iinclude/ test-dll.c -o test-dll dll\libzstd.dll
+```
+The compiled executable will require ZSTD DLL which is available at `dll\libzstd.dll`. 
+
+
 #### Obsolete streaming API
 
 Streaming is now provided within `zstd.h`.
index 34d19855c95b33199a4e20a75d6a4fd6fb09216f..957a29f3560f2b3c83a9733ca222be80b8be5477 100644 (file)
@@ -39,7 +39,7 @@ The header files from `include\` and the dynamic library `dll\libzstd.dll`
 are required to compile a project using gcc/MinGW.
 The dynamic library has to be added to linking options.
 It means that if a project that uses ZSTD consists of a single `test-dll.c`
-file it should be compiled with "libzstd.dll". For example:
+file it should be linked with `dll\libzstd.dll`. For example:
 ```
     gcc $(CFLAGS) -Iinclude\ test-dll.c -o test-dll dll\libzstd.dll
 ```