Brotli compression format
Go to file
Eugene Kliuchnikov 6ece1d8791 Move files & update paths (#541)
* Move files & update paths

* Rename build to scripts.

* Fix paths

* Fix script.
2017-04-23 14:07:08 +02:00
c Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
csharp Add C# transpilation script. (#538) 2017-04-10 21:16:08 +02:00
docs Move java/ to java/org/brotli/ to fix sources.jar structure (#517) 2017-02-28 16:59:52 +01:00
go/cbrotli Simplify go brotli wrapper. (#540) 2017-04-13 20:05:36 +02:00
java/org/brotli Update API to v1.0.0 (#537) 2017-04-10 15:39:00 +02:00
python Python: Create Makefile for development shortcuts (#488) 2016-12-21 10:17:11 +01:00
research Research (#491) 2016-12-22 13:03:28 +01:00
scripts Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
tests Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
.gitignore Python: Simplify test suite generation by using unittest discovery (#485) 2016-12-20 14:40:47 +01:00
.gitmodules Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
.travis.yml Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
BUILD Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
CMakeLists.txt Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
configure Do not assume that bash is installed in /bin (#477) 2016-12-09 08:58:13 +01:00
configure-cmake Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
CONTRIBUTING.md Apply 80-chars limit to CONTRIBUTING.md 2016-02-18 15:20:59 +01:00
LICENSE Prepare to release 0.4.0 2016-06-14 15:07:13 +02:00
Makefile Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
MANIFEST.in Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
premake5.lua Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
README.md Add Brotli logo to README head (#535) 2017-04-04 13:21:36 +02:00
setup.cfg Python: Update README with information about code formatting 2016-10-17 13:57:56 -04:00
setup.py Move files & update paths (#541) 2017-04-23 14:07:08 +02:00
WORKSPACE Add go wrapper, streamline java decoder: (#524) 2017-03-22 12:41:19 +01:00

Brotli

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.

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

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

Build Status

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

CMake

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

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

You can use other CMake configuration. For example, to build static libraries and use a custom installation directory:

$ mkdir out-static && \
  cd out-static && \
  ../configure-cmake --disable-shared-libs --prefix='/my/prefix/dir/'
$ make install

Premake5

See Premake5

Python

To install the Python module from source, run the following:

$ python setup.py install

See the Python readme for more details on testing and development.

Benchmarks

Independent decoder implementation by Mark Adler, based entirely on format specification.

JavaScript port of brotli decoder. Could be used directly via npm install brotli