ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed Markdown warnings. No visible changes.

Browse Source
This commit is contained in:
Antonio Bueno
2020-08-19 12:36:28 +02:00
committed by GitHub
parent 5deeaf810d
commit 77c97089fc
1 changed files with 16 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/dll/example/README.md
+16 -22
View File
@@ -1,23 +1,21 @@
ZSTD Windows binary package # ZSTD Windows binary package
====================================
#### The package contents ## The package contents
- `zstd.exe` : Command Line Utility, supporting gzip-like arguments - `zstd.exe` : Command Line Utility, supporting gzip-like arguments
- `dll\libzstd.dll` : The ZSTD dynamic library (DLL) - `dll\libzstd.dll` : The ZSTD dynamic library (DLL)
- `dll\libzstd.lib` : The import library of the ZSTD dynamic library (DLL) for Visual C++ - `dll\libzstd.lib` : The import library of the ZSTD dynamic library (DLL) for Visual C++
- `example\` : The example of usage of the ZSTD library - `example\` : The example of usage of the ZSTD library
- `include\` : Header files required by the ZSTD library - `include\` : Header files required by the ZSTD library
- `static\libzstd_static.lib` : The static ZSTD library (LIB) - `static\libzstd_static.lib` : The static ZSTD library (LIB)
## Usage of Command Line Interface
#### Usage of Command Line Interface
Command Line Interface (CLI) supports gzip-like arguments. Command Line Interface (CLI) supports gzip-like arguments.
By default CLI takes an input file and compresses it to an output file: By default CLI takes an input file and compresses it to an output file:
```
Usage: zstd [arg] [input] [output] Usage: zstd [arg] [input] [output]
```
The full list of commands for CLI can be obtained with `-h` or `-H`. The ratio can 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 be improved with commands from `-3` to `-16` but higher levels also have slower
compression. CLI includes in-memory compression benchmark module with compression compression. CLI includes in-memory compression benchmark module with compression
@@ -25,36 +23,32 @@ levels starting from `-b` and ending with `-e` with iteration time of `-i` secon
CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined
into `-b1e18i1`. into `-b1e18i1`.
## The example of usage of static and dynamic ZSTD libraries with gcc/MinGW
#### The example of usage of static and dynamic ZSTD libraries with gcc/MinGW
Use `cd example` and `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 ZSTD library from the `dll` directory. `fullbench-dll` uses a dynamic ZSTD library from the `dll` directory.
`fullbench-lib` uses a static ZSTD library from the `lib` directory. `fullbench-lib` uses a static ZSTD library from the `lib` directory.
## Using ZSTD DLL with gcc/MinGW
#### Using ZSTD DLL with gcc/MinGW
The header files from `include\` and the dynamic library `dll\libzstd.dll` The header files from `include\` and the dynamic library `dll\libzstd.dll`
are required to compile a project using gcc/MinGW. are required to compile a project using gcc/MinGW.
The dynamic library has to be added to linking options. The dynamic library has to be added to linking options.
It means that if a project that uses ZSTD consists of a single `test-dll.c` It means that if a project that uses ZSTD consists of a single `test-dll.c`
file it should be linked with `dll\libzstd.dll`. For example: file it should be linked with `dll\libzstd.dll`. For example:
```
gcc $(CFLAGS) -Iinclude\ test-dll.c -o test-dll dll\libzstd.dll gcc $(CFLAGS) -Iinclude\ test-dll.c -o test-dll dll\libzstd.dll
```
The compiled executable will require ZSTD DLL which is available at `dll\libzstd.dll`. The compiled executable will require ZSTD DLL which is available at `dll\libzstd.dll`.
## The example of usage of static and dynamic ZSTD libraries with Visual C++
#### The example of usage of static and dynamic ZSTD libraries with Visual C++
Open `example\fullbench-dll.sln` to compile `fullbench-dll` that uses a Open `example\fullbench-dll.sln` to compile `fullbench-dll` that uses a
dynamic ZSTD library from the `dll` directory. The solution works with Visual C++ dynamic ZSTD 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 2010 or newer. When one will open the solution with Visual C++ newer than 2010
then the solution will upgraded to the current version. then the solution will upgraded to the current version.
## Using ZSTD DLL with Visual C++
#### Using ZSTD DLL with Visual C++
The header files from `include\` and the import library `dll\libzstd.lib` The header files from `include\` and the import library `dll\libzstd.lib`
are required to compile a project using Visual C++. are required to compile a project using Visual C++.