Merge pull request from mapbox/doc

Clarify documentation for dependencies
This commit is contained in:
Eric Fischer 2015-07-28 12:39:40 -07:00
commit b115a07005
2 changed files with 40 additions and 10 deletions

@ -165,10 +165,21 @@ lower resolutions before failing if it still doesn't fit.
Development
-----------
Requires protoc (`brew install protobuf` or
`apt-get install libprotobuf-dev` and `protobuf-compiler`),
`md2man` (`gem install md2man`), and sqlite3 (`apt-get install libsqlite3-dev`).
To build:
Requires protoc and sqlite3. Rebuilding the manpage
uses md2man (`gem install md2man`).
MacOS:
brew install protobuf
brew install sqlite
Linux:
sudo apt-get install libprotobuf-dev
sudo apt-get install protobuf-compiler
sudo apt-get install libsqlite3-dev
Then build:
make
@ -184,4 +195,4 @@ Check out [some examples of maps made with tippecanoe](MADE_WITH.md)
Name
----
The name is [a joking reference](http://en.wikipedia.org/wiki/Tippecanoe_and_Tyler_Too) to making tiles.
The name is [a joking reference](http://en.wikipedia.org/wiki/Tippecanoe_and_Tyler_Too) to a "tiler" for making map tiles.

@ -187,10 +187,29 @@ If a tile is larger than 500K, it will try encoding that tile at progressively
lower resolutions before failing if it still doesn't fit.
.SH Development
.PP
Requires protoc (\fB\fCbrew install protobuf\fR or
\fB\fCapt\-get install libprotobuf\-dev\fR and \fB\fCprotobuf\-compiler\fR),
\fB\fCmd2man\fR (\fB\fCgem install md2man\fR), and sqlite3 (\fB\fCapt\-get install libsqlite3\-dev\fR).
To build:
Requires protoc and sqlite3. Rebuilding the manpage
uses md2man (\fB\fCgem install md2man\fR).
.PP
MacOS:
.PP
.RS
.nf
brew install protobuf
brew install sqlite
.fi
.RE
.PP
Linux:
.PP
.RS
.nf
sudo apt\-get install libprotobuf\-dev
sudo apt\-get install protobuf\-compiler
sudo apt\-get install libsqlite3\-dev
.fi
.RE
.PP
Then build:
.PP
.RS
.nf
@ -212,4 +231,4 @@ Check out some examples of maps made with tippecanoe
.SH Name
.PP
The name is a joking reference
\[la]http://en.wikipedia.org/wiki/Tippecanoe_and_Tyler_Too\[ra] to making tiles.
\[la]http://en.wikipedia.org/wiki/Tippecanoe_and_Tyler_Too\[ra] to a "tiler" for making map tiles.