aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEugene Kliuchnikov <eustas@google.com>2017-04-28 13:16:59 +0200
committerGitHub <noreply@github.com>2017-04-28 13:16:59 +0200
commitd00ccae57fa92ee0aaa5a16ee842db19cd282cbd (patch)
tree868ac5155636bcf9e003be183e3f19f6c4a83f7b /README.md
parent6ece1d8791a887c1b3fd500435be97d42921cee7 (diff)
downloadbrotli-d00ccae57fa92ee0aaa5a16ee842db19cd282cbd.zip
brotli-d00ccae57fa92ee0aaa5a16ee842db19cd282cbd.tar.gz
brotli-d00ccae57fa92ee0aaa5a16ee842db19cd282cbd.tar.bz2
Split auto-CMake and plain CMake build manual
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/README.md b/README.md
index e56ed54..637d52b 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,24 @@ https://groups.google.com/forum/#!forum/brotli
### Build instructions
-#### Make
+#### Autotools-style CMake
-To build and run tests, simply do:
+[configure-cmake](https://github.com/nemequ/configure-cmake) is an
+autotools-style configure script for CMake-based projects.
- $ ./configure && make
+The basic commands to build, test and install brotli are:
+
+ $ mkdir out && cd out
+ $ ../configure-cmake
+ $ make
+ $ make test
+ $ make install
-If you want to install brotli, use one of the more advanced build systems below.
+To build static libraries use `--disable-shared-libs` argument:
+
+ $ mkdir out-static && cd out-static
+ $ ../configure-cmake --disable-shared-libs
+ $ make install
#### Bazel
@@ -35,17 +46,18 @@ See [Bazel](http://www.bazel.build/)
The basic commands to build, test and install brotli are:
- $ mkdir out && cd out && ../configure-cmake && make
+ $ 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:
+build static libraries:
- $ mkdir out-static && \
- cd out-static && \
- ../configure-cmake --disable-shared-libs --prefix='/my/prefix/dir/'
- $ make install
+ $ mkdir out-static && cd out-static
+ $ cmake .. -DBUILD_SHARED_LIBS=OFF
+ $ make
#### Premake5