README

== README ==

⚠️ DEPRECATED — This library is no longer actively maintained.

QuickLZ was a fast compression library useful in its era, but it has been superseded by modern alternatives that offer better compression ratios, faster throughput, or both:

• LZ4 — https://github.com/lz4/lz4 • Zstandard — https://github.com/facebook/zstd • Snappy — https://github.com/google/snappy

For new projects, one of the above is strongly recommended over QuickLZ.

This repository is preserved for historical and reference purposes.

== 0. The Quick Version ==

Do this: export PREFIX=/usr/local ./configure -DCMAKE_INSTALL_PREFIX:PATH=PREFIX make install (cd python && env python ./setup.py install --prefix=PREFIX)

To compile with debugging symbols, use this option to ./configure: ./configure -DCMAKE_BUILD_TYPE=debug

== 1. PREREQUISITES ==

This project requires:

• Cross-platform Make (CMake) v2.8+
• GNU Make or equivalent.
• GCC or an alternative, reasonably conformant C++ compiler.
• Python 2.6/2.7 (for the python module)

== 2. BUILDING ==

This project uses the Cross-platform Make (CMake) build system. However, we have conveniently provided a wrapper configure script and Makefile so that the typical build invocation of "./configure" followed by "make" will work. For a list of all possible build targets, use the command "make help".

NOTE: Users of CMake may believe that the top-level Makefile has been generated by CMake; it hasn't, so please do not delete that file.

== 3. INSTALLING ==

Once the project has been built (see "BUILDING"), execute "sudo make install".

== 4. CONTRIBUTING ==

Clone this project at github and then send a pull request! https://github.com/robottwo/quicklz