Skip to content
This repository has been archived by the owner on Oct 30, 2021. It is now read-only.

Update install/build instructions in readme #97

Merged
merged 1 commit into from
May 22, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![coalescemulti](https://cloud.githubusercontent.com/assets/83384/21327650/3588be54-c5fe-11e6-894e-cdaa68ecfa5f.jpg)