aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFrédéric Wang <fwang@igalia.com>2016-10-12 21:58:34 +0200
committerFrédéric Wang <fred.wang@free.fr>2016-10-12 22:00:35 +0200
commit8db7411bbcc5af86d6f5a8bc47bce2052b2aab0d (patch)
tree9ef4de8d31958748f3676c9a65bc7ba183a1b0da /README.md
parent85817beba8e70e1b31d9d9519623e9abdb602ed3 (diff)
downloadbrotli-8db7411bbcc5af86d6f5a8bc47bce2052b2aab0d.zip
brotli-8db7411bbcc5af86d6f5a8bc47bce2052b2aab0d.tar.gz
brotli-8db7411bbcc5af86d6f5a8bc47bce2052b2aab0d.tar.bz2
Add some basic build instructions in the README.md #166
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
index e87d8ac..1e7225d 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,46 @@ 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 test
+ $ make install
+
+You can use other [CMake](https://cmake.org/) configuration. For example, to
+build shared libraries and use a custom installation directory:
+
+ $ mkdir out-shared && \
+ cd out-shared && \
+ cmake .. -DBUILD_SHARED_LIBS=1 -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 binding are:
+
+ $ python setup.py build_ext test
+ $ python setup.py install
+
### 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)