From 3d2cfa2838583505e83fa913801a54c9c8269754 Mon Sep 17 00:00:00 2001 From: Dane Springmeyer Date: Tue, 2 May 2017 12:19:16 -0700 Subject: [PATCH] Update install/build instructions in readme --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4d92a8f..1935fdc 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,37 @@ carmen-cache ------------ Protobuf-based cache. Written originally for use in [carmen](https://github.com/mapbox/carmen) geocoder. -### Installing from source +### Install -First install mason and then (from inside the carmen-cache) directory, install rocksdb: +To install `carmen-cache` run: ``` -mason install bzip2 1.0.6 -mason link bzip2 1.0.6 -mason install rocksdb 4.13 -mason link rocksdb 4.13 +npm install ``` -Then you can build carmen-cache from source like: +By default, binaries are provided for `64 bit OS X >= 10.8` and `64 bit Linux (>= Ubuntu Trusty)`. On those platforms no external dependencies are needed. + +Other platforms will fall back to a source compile: see [Source Build](#Source Build) for details + +### Source Build + +To build from source run: ``` -npm install --build-from-source +make ``` +This will automatically: + + - Install [mason](https://github.com/mapbox/mason/) locally + - Install several C/C++ dependencies locally (in `mason_packages`) via mason: bzip, rocksdb, protozero, and the clang++ compiler + +To do a full rebuild run: `make clean` + +### Publishing + +See [CONTRIBUTING](CONTRIBUTING.md) for how to release a new carmen-cache version. + ### Coalesce docs (incomplete) -![coalescemulti](https://cloud.githubusercontent.com/assets/83384/21327650/3588be54-c5fe-11e6-894e-cdaa68ecfa5f.jpg) \ No newline at end of file +![coalescemulti](https://cloud.githubusercontent.com/assets/83384/21327650/3588be54-c5fe-11e6-894e-cdaa68ecfa5f.jpg)