2016-06-21 11:41:25 +00:00
|
|
|
### Introduction
|
2014-10-14 11:08:35 +00:00
|
|
|
|
|
|
|
|
Brotli is a generic-purpose lossless compression algorithm that compresses data
|
|
|
|
|
using a combination of a modern variant of the LZ77 algorithm, Huffman coding
|
|
|
|
|
and 2nd order context modeling, with a compression ratio comparable to the best
|
|
|
|
|
currently available general-purpose compression methods. It is similar in speed
|
|
|
|
|
with deflate but offers more dense compression.
|
|
|
|
|
|
2016-08-02 11:27:29 +00:00
|
|
|
The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://www.ietf.org/rfc/rfc7932.txt).
|
2014-10-14 11:08:35 +00:00
|
|
|
|
2015-11-27 09:40:56 +00:00
|
|
|
Brotli is open-sourced under the MIT License, see the LICENSE file.
|
2015-06-12 12:31:47 +00:00
|
|
|
|
|
|
|
|
Brotli mailing list:
|
|
|
|
|
https://groups.google.com/forum/#!forum/brotli
|
2016-06-14 13:53:06 +00:00
|
|
|
|
|
|
|
|
[](https://travis-ci.org/google/brotli)
|
2016-06-21 11:41:25 +00:00
|
|
|
|
2016-10-12 19:58:34 +00:00
|
|
|
### Build instructions
|
|
|
|
|
|
|
|
|
|
#### Make
|
|
|
|
|
|
|
|
|
|
To build and run tests, simply do:
|
|
|
|
|
|
|
|
|
|
$ ./configure && make
|
|
|
|
|
|
|
|
|
|
If you want to install brotli, use one of the more advanced build systems below.
|
|
|
|
|
|
|
|
|
|
#### Bazel
|
|
|
|
|
|
2016-11-09 13:04:09 +00:00
|
|
|
See [Bazel](http://www.bazel.build/)
|
2016-10-12 19:58:34 +00:00
|
|
|
|
|
|
|
|
#### CMake
|
|
|
|
|
|
|
|
|
|
The basic commands to build, test and install brotli are:
|
|
|
|
|
|
2016-12-20 16:45:40 +00:00
|
|
|
$ mkdir out && cd out && ../configure-cmake && make
|
2016-10-19 19:42:41 +00:00
|
|
|
$ make test
|
2016-10-12 19:58:34 +00:00
|
|
|
$ make install
|
|
|
|
|
|
|
|
|
|
You can use other [CMake](https://cmake.org/) configuration. For example, to
|
2016-10-18 14:45:32 +00:00
|
|
|
build static libraries and use a custom installation directory:
|
2016-10-12 19:58:34 +00:00
|
|
|
|
2016-10-19 19:42:41 +00:00
|
|
|
$ mkdir out-static && \
|
|
|
|
|
cd out-static && \
|
2016-12-20 16:45:40 +00:00
|
|
|
../configure-cmake --disable-shared-libs --prefix='/my/prefix/dir/'
|
2016-10-12 19:58:34 +00:00
|
|
|
$ make install
|
|
|
|
|
|
|
|
|
|
#### Premake5
|
|
|
|
|
|
|
|
|
|
See [Premake5](https://premake.github.io/)
|
|
|
|
|
|
|
|
|
|
#### Python
|
|
|
|
|
|
2016-12-21 09:17:11 +00:00
|
|
|
To install the Python module from source, run the following:
|
2016-10-12 19:58:34 +00:00
|
|
|
|
|
|
|
|
$ python setup.py install
|
|
|
|
|
|
2016-12-21 09:17:11 +00:00
|
|
|
See the [Python readme](python/README.md) for more details on testing
|
|
|
|
|
and development.
|
2016-10-17 17:00:14 +00:00
|
|
|
|
2016-08-10 12:44:59 +00:00
|
|
|
### Benchmarks
|
|
|
|
|
* [Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/) / [Unstable Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/unstable/)
|
|
|
|
|
* [Large Text Compression Benchmark](http://mattmahoney.net/dc/text.html)
|
|
|
|
|
* [Lzturbo Benchmark](https://sites.google.com/site/powturbo/home/benchmark)
|
|
|
|
|
|
2016-06-21 11:41:25 +00:00
|
|
|
### Related projects
|
|
|
|
|
Independent [decoder](https://github.com/madler/brotli) implementation by Mark Adler, based entirely on format specification.
|
|
|
|
|
|
|
|
|
|
JavaScript port of brotli [decoder](https://github.com/devongovett/brotli.js). Could be used directly via `npm install brotli`
|
