Fix API documentation + theoretical NPEs (#602)

3 files changed
tree: 062c36d7bced8570208a938d1c583063aa242919
  1. c/
  2. csharp/
  3. docs/
  4. go/
  5. java/
  6. js/
  7. python/
  8. research/
  9. scripts/
  10. tests/
  11. .editorconfig
  12. .gitignore
  13. .gitmodules
  14. .travis.yml
  15. BUILD
  16. CMakeLists.txt
  17. configure
  18. configure-cmake
  19. CONTRIBUTING.md
  20. LICENSE
  21. Makefile
  22. MANIFEST.in
  23. premake5.lua
  24. README.md
  25. setup.cfg
  26. setup.py
  27. WORKSPACE
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.

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 AppVeyor Build Status

Build instructions

Autotools-style CMake

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

Bazel

See Bazel

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 configuration.

Premake5

See Premake5

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 for more details on installing from source, development, and testing.

Benchmarks

Related projects

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

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

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

Hand ported decoder / encoder in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#

7Zip plugin