README.md
1Projects for various integrated development environments (IDE)
2==============================================================
3
4#### Included projects
5
6The following projects are included with the lz4 distribution:
7- `cmake` - CMake project
8- `meson` - Meson project
9- `visual` - scripts to generate Visual Studio solutions from `cmake` script
10- `VS2022` - Visual Studio 2022 solution - will soon be deprecated, prefer `visual` generators
11
12
13#### Projects available within VS2022\lz4.sln
14
15The Visual Studio solution file `lz4.sln` contains many projects that will be compiled to the
16`build\VS2010\bin\$(Platform)_$(Configuration)` directory. For example `lz4` set to `x64` and
17`Release` will be compiled to `build\VS2010\bin\x64_Release\lz4.exe`. The solution file contains the
18following projects:
19
20- `lz4` : Command Line Utility, supporting gzip-like arguments
21- `datagen` : Synthetic and parametrable data generator, for tests
22- `frametest` : Test tool that checks lz4frame integrity on target platform
23- `fullbench` : Precisely measure speed for each lz4 inner functions
24- `fuzzer` : Test tool, to check lz4 integrity on target platform
25- `liblz4` : A static LZ4 library compiled to `liblz4_static.lib`
26- `liblz4-dll` : A dynamic LZ4 library (DLL) compiled to `liblz4.dll` with the import library `liblz4.lib`
27- `fullbench-dll` : The fullbench program compiled with the import library; the executable requires LZ4 DLL
28
29
30#### Using LZ4 DLL with Microsoft Visual C++ project
31
32The header files `lib\lz4.h`, `lib\lz4hc.h`, `lib\lz4frame.h` and the import library
33`build\VS2010\bin\$(Platform)_$(Configuration)\liblz4.lib` are required to
34compile a project using Visual C++.
35
361. The path to header files should be added to `Additional Include Directories` that can
37 be found in Project Properties of Visual Studio IDE in the `C/C++` Property Pages on the `General` page.
382. The import library has to be added to `Additional Dependencies` that can
39 be found in Project Properties in the `Linker` Property Pages on the `Input` page.
40 If one will provide only the name `liblz4.lib` without a full path to the library
41 then the directory has to be added to `Linker\General\Additional Library Directories`.
42
43The compiled executable will require LZ4 DLL which is available at
44`build\VS2010\bin\$(Platform)_$(Configuration)\liblz4.dll`.
45