summaryrefslogtreecommitdiffstats
path: root/lib/README.md
diff options
context:
space:
mode:
authorPrzemyslaw Skibinski <inikep@gmail.com>2016-11-16 07:59:18 (GMT)
committerPrzemyslaw Skibinski <inikep@gmail.com>2016-11-16 07:59:18 (GMT)
commit2e10aab20f17adfffb2379e828124be12c774779 (patch)
tree3a0ea44e93d92ba5523b0d5d23ef392cd236859b /lib/README.md
parent4235e5e25f79828e6192eb17fac7a24992aed07d (diff)
downloadlz4-2e10aab20f17adfffb2379e828124be12c774779.zip
lz4-2e10aab20f17adfffb2379e828124be12c774779.tar.gz
lz4-2e10aab20f17adfffb2379e828124be12c774779.tar.bz2
MinGW doesn't require the import library at all
Diffstat (limited to 'lib/README.md')
-rw-r--r--lib/README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/README.md b/lib/README.md
index 430be1f..18793d4 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -42,12 +42,16 @@ It must be used with static linking ***only***.
DLL can be created using MinGW+MSYS with the `make liblz4` command.
This command creates `dll\liblz4.dll` and the import library `dll\liblz4.lib`.
-To compile a project the import library has to be added to linking options.
+The import library is only required with Visual C++.
+The header files `lz4.h`, `lz4hc.h`, `lz4frame.h` and the dynamic library
+`dll\liblz4.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 compiled with "liblz4.lib". For example:
```
- gcc $(CFLAGS) test-dll.c -o test-dll liblz4.lib
+ gcc $(CFLAGS) -Iinclude/ test-dll.c -o test-dll dll\liblz4.dll
```
+The compiled executable will require LZ4 DLL which is available at `dll\liblz4.dll`.
#### Miscellaneous