summaryrefslogtreecommitdiffstats
path: root/lib/README.md
diff options
context:
space:
mode:
authorPrzemyslaw Skibinski <inikep@gmail.com>2016-11-10 17:30:59 (GMT)
committerPrzemyslaw Skibinski <inikep@gmail.com>2016-11-10 17:30:59 (GMT)
commit52251d970956c992801b6b7434fe092751f7731e (patch)
tree14a6c2e07b308d19d9f7a2f38a90f5a926cbc13c /lib/README.md
parent72a4a84df7dbb61e2ddc939e23a9761367c34291 (diff)
downloadlz4-52251d970956c992801b6b7434fe092751f7731e.zip
lz4-52251d970956c992801b6b7434fe092751f7731e.tar.gz
lz4-52251d970956c992801b6b7434fe092751f7731e.tar.bz2
Using MinGW+MSYS to create DLL
Diffstat (limited to 'lib/README.md')
-rw-r--r--lib/README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/README.md b/lib/README.md
index e4649aa..051ef54 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -19,7 +19,7 @@ The variant still depends on regular `lz4` source files.
In particular, the decompression is still provided by `lz4.c`.
-#### Compatibiliy issues
+#### Compatibility issues
In order to produce files or streams compatible with `lz4` command line utility,
it's necessary to encode lz4-compressed blocks using the [official interoperable frame format].
@@ -38,6 +38,18 @@ It contains definitions which are not guaranteed to remain stable within future
It must be used with static linking ***only***.
+#### Using MinGW+MSYS to create DLL
+
+DLL can be created using MinGW+MSYS with the "make liblz4" command.
+This command creates "liblz4.dll" and the import library "liblz4.dll.a".
+To compile a project the import 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.dll.a". For example:
+```
+ gcc $CFLAGS test-dll.c -o test-dll liblz4.dll.a
+```
+
+
#### Miscellaneous
Other files present in the directory are not source code. There are :