diff options
Diffstat (limited to 'lib/dll')
| -rw-r--r-- | lib/dll/example/README.md | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/lib/dll/example/README.md b/lib/dll/example/README.md index 216c1e9..4908663 100644 --- a/lib/dll/example/README.md +++ b/lib/dll/example/README.md @@ -1,13 +1,13 @@ -The static and dynamic LZ4 libraries +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++ -- `example\` : 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 @@ -16,12 +16,14 @@ The static and dynamic LZ4 libraries Command Line Interface (CLI) supports gzip-like arguments. By default CLI takes an input file and compresses it to an output file: ``` -Usage: lz4 [arg] [input] [output] + Usage: lz4 [arg] [input] [output] ``` -The full list of commands for CLI can be obtained with `-h` or `-H`. -The ratio can be improved with commands from `-3` to `-16` but higher levels also have slower compression. -CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined into `-b1e18i1`. -CLI includes in-memory compression benchmark module with compression levels starting from `-b` and ending with `-e` with iteration time of `-i` seconds. +The full list of commands for CLI can be obtained with `-h` or `-H`. The ratio can +be improved with commands from `-3` to `-16` but higher levels also have slower +compression. CLI includes in-memory compression benchmark module with compression +levels starting from `-b` and ending with `-e` with iteration time of `-i` seconds. +CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined +into `-b1e18i1`. #### The example of usage of static and dynamic LZ4 libraries with gcc/MinGW |