summaryrefslogtreecommitdiffstats
path: root/lib/dll
diff options
context:
space:
mode:
authorPrzemyslaw Skibinski <inikep@gmail.com>2016-11-16 08:53:07 (GMT)
committerPrzemyslaw Skibinski <inikep@gmail.com>2016-11-16 08:53:07 (GMT)
commit8b48d5e446267418082b4d389fa6729e5a03a823 (patch)
tree7a3d828d8f7af69ed825f4435bef6cb2ed0bd396 /lib/dll
parent11f6217cc287d1b8d79b40361ed6b6ce6ef42172 (diff)
downloadlz4-8b48d5e446267418082b4d389fa6729e5a03a823.zip
lz4-8b48d5e446267418082b4d389fa6729e5a03a823.tar.gz
lz4-8b48d5e446267418082b4d389fa6729e5a03a823.tar.bz2
updated example\README.md
Diffstat (limited to 'lib/dll')
-rw-r--r--lib/dll/example/README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/lib/dll/example/README.md b/lib/dll/example/README.md
index bb3dbd6..6f2b402 100644
--- a/lib/dll/example/README.md
+++ b/lib/dll/example/README.md
@@ -3,16 +3,17 @@ The static and dynamic LZ4 libraries
#### The package contents
-- `dll\liblz4.dll` : The DLL of LZ4 library
-- `dll\liblz4.lib` : The import library of LZ4 library for Visual C++
-- `fullbench\` : The example of usage of LZ4 library
-- `include\` : Header files required with LZ4 library
+- `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++
+- `example\` : The example of usage of LZ4 library
+- `include\` : Header files required with LZ4 library
- `static\liblz4_static.lib` : The static LZ4 library
#### The example of usage of static and dynamic LZ4 libraries with gcc/MinGW
-Use `make` to build `fullbench-dll` and `fullbench-lib`.
+Use `cd example` and `make` to build `fullbench-dll` and `fullbench-lib`.
`fullbench-dll` uses a dynamic LZ4 library from the `dll` directory.
`fullbench-lib` uses a static LZ4 library from the `lib` directory.
@@ -25,14 +26,14 @@ 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.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\liblz4.dll
```
The compiled executable will require LZ4 DLL which is available at `dll\liblz4.dll`.
#### The example of usage of static and dynamic LZ4 libraries with Visual C++
-Open `fullbench\fullbench-dll.sln` to compile `fullbench-dll` that uses a
+Open `example\fullbench-dll.sln` to compile `fullbench-dll` that uses a
dynamic LZ4 library from the `dll` directory. The solution works with Visual C++
2010 or newer. When one will open the solution with Visual C++ newer than 2010
then the solution will upgraded to the current version.