brotli/README.md

### 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://www.ietf.org/rfc/rfc7932.txt).

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

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

[![Build Status](https://travis-ci.org/google/brotli.svg?branch=master)](https://travis-ci.org/google/brotli)

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

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

#### CMake

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

    $ mkdir out && cd out && cmake .. && make
    $ make test
    $ make install

You can use other [CMake](https://cmake.org/) configuration. For example, to
build static libraries and use a custom installation directory:

    $ mkdir out-static && \
      cd out-static && \
      cmake .. -DBUILD_SHARED_LIBS=0 -DCMAKE_INSTALL_PREFIX='/my/install/dir/'
    $ make install

#### Premake5

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

#### Python

The basic commands to build, test, and install the Python module are:

    $ python setup.py build test
    $ python setup.py install

See the [Python readme](python/README.md) for more details.

### 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
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 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.`

Update the spec reference to RFC 7932, remove the old internet draft. 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).`
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
			`[![Build Status](https://travis-ci.org/google/brotli.svg?branch=master)](https://travis-ci.org/google/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`

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

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

			`#### CMake`

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

Fix build instructions for cmake 2016-10-19 19:42:41 +00:00			`$ mkdir out && cd out && cmake .. && make`
			`$ make test`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00			`$ make install`

			`You can use other [CMake](https://cmake.org/) configuration. For example, to`
Build shared libraries by default * Declare `BUILD_SHARED_LIBS` option for CMake * Define `${LIB}_SHARED_COMPILATION` when compiling shared library * Define and use BROTLI_xxx_API * Fix remaining unprefixed defines in port.h 2016-10-18 14:45:32 +00:00			`build static libraries and use a custom installation directory:`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Fix build instructions for cmake 2016-10-19 19:42:41 +00:00			`$ mkdir out-static && \`
			`cd out-static && \`
Build shared libraries by default * Declare `BUILD_SHARED_LIBS` option for CMake * Define `${LIB}_SHARED_COMPILATION` when compiling shared library * Define and use BROTLI_xxx_API * Fix remaining unprefixed defines in port.h 2016-10-18 14:45:32 +00:00			`cmake .. -DBUILD_SHARED_LIBS=0 -DCMAKE_INSTALL_PREFIX='/my/install/dir/'`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00			`$ make install`

			`#### Premake5`

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

			`#### Python`

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			`The basic commands to build, test, and install the Python module are:`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00
Python: Use "build" instead of "build_ext" in scripts (#460) Previously, the Python package consisted of a single extension module, so `build_ext` was sufficient. Now, the package contains a native module and an extension module, so both `build_py` and `build_ext` are required. Instead, run `build`, which calls both `build_py` and `build_ext` automatically. 2016-10-31 11:58:45 +00:00			`$ python setup.py build test`
Add some basic build instructions in the README.md #166 2016-10-12 19:58:34 +00:00			`$ python setup.py install`

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			`See the [Python readme](python/README.md) for more details.`

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`
			`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`