lib/lz4

mirror of https://github.com/lz4/lz4.git synced 2026-10-24 01:48:57 +03:00

Files

Yann Collet f42fdc171d README: refresh text, links and build pointers

- grammar: "a lossless compression algorithm", "multi-core CPUs",
  "The LZ4 library ... the BSD 2-Clause license", "defined in"
- clarify that the acceleration factor tunes compression speed
- dictionary API / CLI links were pinned to v1.8.3:
  point to the in-tree lib/lz4frame.h and programs/lz4.1.md instead
- Zstandard dictionary builder link: v1.3.5 -> dev
- mention the GPL-2.0-or-later license of the CLI, as stated in LICENSE
- switch homepage, zlib, zstd and Silesia links to https
- point to build/ for CMake, Meson and Visual Studio builds
- vcpkg instructions: ./vcpkg, not ./vcpkg.exe, after bootstrap-vcpkg.sh
- list the API headers in the Documentation section

build/README.md: VS2022 solution outputs to build\VS2022\bin, not build\VS2010\bin

2026-10-17 17:57:45 -07:00

cmake

cmake: enable multithreading in lz4 programs on pthread platforms

2026-10-12 16:21:54 -07:00

make

Avoid resetting make jobserver in submakes

2026-05-28 20:48:18 -07:00

meson

fix test errors

2026-02-13 18:04:27 -08:00

visual

fixed VS2017 build script

2024-07-11 17:09:03 -07:00

VS2022

Windows CI: test lz4 -l on an empty file, NEWS for #1740

2026-10-17 09:01:28 -07:00

.gitignore

Update .gitignore

2023-05-20 22:04:25 +09:00

README.md

README: refresh text, links and build pointers

2026-10-17 17:57:45 -07:00

README.md

Projects for various integrated development environments (IDE)

Included projects

The following projects are included with the lz4 distribution:

cmake - CMake project
meson - Meson project
visual - scripts to generate Visual Studio solutions from cmake script
VS2022 - Visual Studio 2022 solution - will soon be deprecated, prefer visual generators

Projects available within VS2022\lz4.sln

The Visual Studio solution file lz4.sln contains many projects that will be compiled to the build\VS2022\bin\$(Platform)_$(Configuration) directory. For example lz4 set to x64 and Release will be compiled to build\VS2022\bin\x64_Release\lz4.exe. The solution file contains the following projects:

lz4 : Command Line Utility, supporting gzip-like arguments
datagen : Synthetic and parametrable data generator, for tests
frametest : Test tool that checks lz4frame integrity on target platform
fullbench : Precisely measure speed for each lz4 inner functions
fuzzer : Test tool, to check lz4 integrity on target platform
liblz4 : A static LZ4 library compiled to liblz4_static.lib
liblz4-dll : A dynamic LZ4 library (DLL) compiled to liblz4.dll with the import library liblz4.lib
fullbench-dll : The fullbench program compiled with the import library; the executable requires LZ4 DLL

Using LZ4 DLL with Microsoft Visual C++ project

The header files lib\lz4.h, lib\lz4hc.h, lib\lz4frame.h and the import library build\VS2022\bin\$(Platform)_$(Configuration)\liblz4.lib are required to compile a project using Visual C++.

The path to header files should be added to Additional Include Directories that can be found in Project Properties of Visual Studio IDE in the C/C++ Property Pages on the General page.
The import library has to be added to Additional Dependencies that can be found in Project Properties in the Linker Property Pages on the Input page. If one will provide only the name liblz4.lib without a full path to the library then the directory has to be added to Linker\General\Additional Library Directories.

The compiled executable will require LZ4 DLL which is available at build\VS2022\bin\$(Platform)_$(Configuration)\liblz4.dll.