summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2022-07-04 22:58:47 (GMT)
committerYann Collet <cyan@fb.com>2022-07-04 22:58:47 (GMT)
commit0af5edc87395084803bc70b529a758f6e69b97ff (patch)
treec6a2bf371aa502058efd71819b748cc8cc0eb673 /lib
parentabe63b490b3254fd8cf15b7def3be5926b15ec49 (diff)
downloadlz4-0af5edc87395084803bc70b529a758f6e69b97ff.zip
lz4-0af5edc87395084803bc70b529a758f6e69b97ff.tar.gz
lz4-0af5edc87395084803bc70b529a758f6e69b97ff.tar.bz2
updated dll README
Diffstat (limited to 'lib')
-rw-r--r--lib/dll/example/README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/dll/example/README.md b/lib/dll/example/README.md
index 223e473..6d93248 100644
--- a/lib/dll/example/README.md
+++ b/lib/dll/example/README.md
@@ -4,8 +4,8 @@ LZ4 Windows binary package
#### The package contents
- `lz4.exe` : Command Line Utility, supporting gzip-like arguments
-- `dll\liblz4.dll` : The DLL of LZ4 library
-- `dll\liblz4.lib` : The import library of LZ4 library for Visual C++
+- `dll\msys-lz4-1.dll` : The DLL of LZ4 library, compiled by msys
+- `dll\liblz4.dll.a` : The import library of LZ4 library for Visual C++
- `example\` : The example of usage of LZ4 library
- `include\` : Header files required with LZ4 library
- `static\liblz4_static.lib` : The static LZ4 library
@@ -35,15 +35,15 @@ Use `cd example` and `make` to build `fullbench-dll` and `fullbench-lib`.
#### Using LZ4 DLL with gcc/MinGW
-The header files from `include\` and the dynamic library `dll\liblz4.dll`
+The header files from `include\` and the dynamic library `dll\msys-lz4-1.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 LZ4 consists of a single `test-dll.c`
-file it should be linked with `dll\liblz4.dll`. For example:
+file it should be linked with `dll\msys-lz4-1.dll`. For example:
```
- gcc $(CFLAGS) -Iinclude\ test-dll.c -o test-dll dll\liblz4.dll
+ gcc $(CFLAGS) -Iinclude\ test-dll.c -o test-dll dll\msys-lz4-1.dll
```
-The compiled executable will require LZ4 DLL which is available at `dll\liblz4.dll`.
+The compiled executable will require LZ4 DLL which is available at `dll\msys-lz4-1.dll`.
#### The example of usage of static and dynamic LZ4 libraries with Visual C++
@@ -56,14 +56,14 @@ then the solution will upgraded to the current version.
#### Using LZ4 DLL with Visual C++
-The header files from `include\` and the import library `dll\liblz4.lib`
+The header files from `include\` and the import library `dll\liblz4.dll.a`
are required to compile a project using Visual C++.
1. The header files should be added to `Additional Include Directories` that can
be found in project properties `C/C++` then `General`.
2. The import library has to be added to `Additional Dependencies` that can
be found in project properties `Linker` then `Input`.
- If one will provide only the name `liblz4.lib` without a full path to the library
+ If one will provide only the name `liblz4.dll.a` without a full path to the library
the directory has to be added to `Linker\General\Additional Library Directories`.
-The compiled executable will require LZ4 DLL which is available at `dll\liblz4.dll`.
+The compiled executable will require LZ4 DLL which is available at `dll\msys-lz4-1.dll`.