brotli/README.md

<p align="center"><img src="https://brotli.org/brotli.svg" alt="Brotli" width="64"></p>

### Introduction

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.

The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://tools.ietf.org/html/rfc7932).

Brotli is open-sourced under the MIT License, see the LICENSE file.

Brotli mailing list:
https://groups.google.com/forum/#!forum/brotli

[![TravisCI Build Status](https://travis-ci.org/google/brotli.svg?branch=master)](https://travis-ci.org/google/brotli)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/google/brotli?branch=master&svg=true)](https://ci.appveyor.com/project/szabadka/brotli)

### Build instructions

#### Autotools-style CMake

[configure-cmake](https://github.com/nemequ/configure-cmake) is an
autotools-style configure script for CMake-based projects (not supported on Windows).

The basic commands to build, test and install brotli are:

    $ mkdir out && cd out
    $ ../configure-cmake
    $ make
    $ make test
    $ make install

By default, debug binaries are built. To generate "release" `Makefile` specify `--disable-debug` option to `configure-cmake`.

#### Bazel

See [Bazel](http://www.bazel.build/)

#### CMake

The basic commands to build and install brotli are:

    $ mkdir out && cd out
    $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed ..
    $ cmake --build . --config Release --target install

You can use other [CMake](https://cmake.org/) configuration.

#### Premake5

See [Premake5](https://premake.github.io/)

#### Python

To install the latest release of the Python module, run the following:

    $ pip install brotli

To install the tip-of-the-tree version, run:

    $ pip install --upgrade git+https://github.com/google/brotli

See the [Python readme](python/README.md) for more details on installing
from source, development, and testing.

### 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)

### Related projects
> **Disclaimer:** Brotli authors take no responsibility for the third party projects mentioned in this section.

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`

Hand ported [decoder / encoder](https://github.com/dominikhlbg/BrotliHaxe) in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#

7Zip [plugin](https://github.com/mcmilk/7-Zip-Zstd)

Dart [native bindings](https://github.com/thosakwe/brotli)
Add Brotli logo to README head (#535) 2017-04-04 11:21:36 +00:00			`<p align="center"><img src="https://brotli.org/brotli.svg" alt="Brotli" width="64"></p>`

Update readme Added "Related projects" section 2016-06-21 11:41:25 +00:00			`### Introduction`
Add top-level README file. Remove brotlispec.txt and add a link to the latest internet-draft instead. 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.`

Readme improvements (#557) * [README] Use tools.ietf.org for displaying RFC7932 tools.ietf.org has HTML links which is helpful when reading in browser * [README] Add appveyor badge 2017-06-06 14:58:46 +00:00			`The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://tools.ietf.org/html/rfc7932).`
Add top-level README file. Remove brotlispec.txt and add a link to the latest internet-draft instead. 2014-10-14 11:08:35 +00:00
Upgrade license to MIT. 2015-11-27 09:40:56 +00:00			`Brotli is open-sourced under the MIT License, see the LICENSE file.`
Update README.md 2015-06-12 12:31:47 +00:00
			`Brotli mailing list:`
			`https://groups.google.com/forum/#!forum/brotli`
Add Travis status 2016-06-14 13:53:06 +00:00
Readme improvements (#557) * [README] Use tools.ietf.org for displaying RFC7932 tools.ietf.org has HTML links which is helpful when reading in browser * [README] Add appveyor badge 2017-06-06 14:58:46 +00:00			`[![TravisCI Build Status](https://travis-ci.org/google/brotli.svg?branch=master)](https://travis-ci.org/google/brotli)`
			`[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/google/brotli?branch=master&svg=true)](https://ci.appveyor.com/project/szabadka/brotli)`
Update readme Added "Related projects" section 2016-06-21 11:41:25 +00:00
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00			`### Build instructions`

Split auto-CMake and plain CMake build manual 2017-04-28 11:16:59 +00:00			`#### Autotools-style CMake`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Split auto-CMake and plain CMake build manual 2017-04-28 11:16:59 +00:00			`[configure-cmake](https://github.com/nemequ/configure-cmake) is an`
Update README.md 2017-09-19 08:46:10 +00:00			`autotools-style configure script for CMake-based projects (not supported on Windows).`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Split auto-CMake and plain CMake build manual 2017-04-28 11:16:59 +00:00			`The basic commands to build, test and install brotli are:`

			`$ mkdir out && cd out`
			`$ ../configure-cmake`
			`$ make`
			`$ make test`
			`$ make install`
Update (#749) Update: * Bazel: fix MSVC configuration * C: common: extended documentation and helpers around distance codes * C: common: enable BROTLI_DCHECK in "debug" builds * C: common: fix implicit trailing zero in `kPrefixSuffix` * C: dec: fix possible bit reader discharge for "large-window" mode * C: dec: simplify distance decoding via lookup table * C: dec: reuse decoder state members memory via union with lookup table * C: dec: add decoder state diagram * C: enc: clarify access to static dictionary * C: enc: improve static dictionary hash * C: enc: add "stream offset" parameter for parallel encoding * C: enc: reorganize hasher; now Q2-Q3 require exactly 256KiB to avoid global TCMalloc lock * C: enc: fix rare access to uninitialized data in ring-buffer * C: enc: reorganize logging / checks in `write_bits.h` * Java: dec: add "large-window" support * Java: dec: improve speed * Java: dec: debug and 32-bit mode are now activated via system properties * Java: dec: demystify some state variables (use better names) * Dictionary generator: add single input mode * Java: dec: modernize tests * Bazel: js: pick working commit for closure rules 2019-04-12 11:57:42 +00:00
Update README.md 2017-09-22 08:28:15 +00:00			By default, debug binaries are built. To generate "release" `Makefile` specify `--disable-debug` option to `configure-cmake`.
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
			`#### Bazel`

Fixes: (#468) * fix slow-down after a long copy (q10-11) * more thorough hashing for long ranges (q10-11) * minor documentation fixes * bazel.io -> bazel.build 2016-11-09 13:04:09 +00:00			`See [Bazel](http://www.bazel.build/)`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
			`#### CMake`

Update README.md 2017-09-04 12:54:51 +00:00			`The basic commands to build and install brotli are:`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Split auto-CMake and plain CMake build manual 2017-04-28 11:16:59 +00:00			`$ mkdir out && cd out`
Update README.md 2017-09-04 12:54:51 +00:00			`$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed ..`
			`$ cmake --build . --config Release --target install`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Update README.md 2017-09-19 08:46:10 +00:00			`You can use other [CMake](https://cmake.org/) configuration.`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
			`#### Premake5`

			`See [Premake5](https://premake.github.io/)`

			`#### Python`

Python: Add a "make install" command and clarify installation docs (#578) Closes #576 2017-08-02 14:59:46 +00:00			`To install the latest release of the Python module, run the following:`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Python: Add a "make install" command and clarify installation docs (#578) Closes #576 2017-08-02 14:59:46 +00:00			`$ pip install brotli`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Update README.md 2017-09-19 09:29:55 +00:00			`To install the tip-of-the-tree version, run:`

			`$ pip install --upgrade git+https://github.com/google/brotli`

Python: Add a "make install" command and clarify installation docs (#578) Closes #576 2017-08-02 14:59:46 +00:00			`See the [Python readme](python/README.md) for more details on installing`
			`from source, development, and testing.`
Python: Update README with information about code formatting Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs format code with the Google style. 2016-10-17 17:00:14 +00:00
Add benchmarks section 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)`

Update readme Added "Related projects" section 2016-06-21 11:41:25 +00:00			`### Related projects`
Add link to 7Zip plugin 2017-08-04 13:40:57 +00:00			`> Disclaimer: Brotli authors take no responsibility for the third party projects mentioned in this section.`

Update readme Added "Related projects" section 2016-06-21 11:41:25 +00:00			`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`
Update Related projects (#565) Add BrotliHaxe 2017-06-22 08:07:07 +00:00
			`Hand ported [decoder / encoder](https://github.com/dominikhlbg/BrotliHaxe) in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#`
Add link to 7Zip plugin 2017-08-04 13:40:57 +00:00
			`7Zip [plugin](https://github.com/mcmilk/7-Zip-Zstd)`
Update README.md (#646) Add mention of Dart native bindings 2018-03-20 11:53:32 +00:00
			`Dart [native bindings](https://github.com/thosakwe/brotli)`