summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
1 files changed, 54 insertions, 9 deletions
diff --git a/README.md b/README.md
index c84485970a..bafdacd55a 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,69 @@
An OpenGL renderer for [Mapbox vector tiles](https://www.mapbox.com/blog/vector-tiles),
-implemented in C++, targeting iOS & OSX.
+implemented in C++, targeting iOS & OS X.
# Build instructions
-## Mac OS X
+## OS X
-You may need to install [glfw3](http://www.glfw.org/docs/latest/):
+Install boost and [glfw3](http://www.glfw.org/docs/latest/):
```
+brew install boost
brew install homebrew/versions/glfw3
```
-```
-mkdir xcode
-cd xcode
-cmake .. -G Xcode
-```
+Then configure the project:
+
+ ./configure
+
+Options include:
+
+ - --boost=/usr/local
+ - --glfw3=/usr/local (by default pkg-config will be used)
+
+Then you can build the OS X app with make:
+
+ make app
+
+Or generate a dual iOS/OS X-compatible Xcode project for `libllmr` to include as a subproject:
+
+ make xcode # then open llmr.xcodeproj
+
+## Ubuntu
+
+Install a `-std=c++11` capable compiler
+
+ sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
+ sudo apt-get install gcc-4.8 g++-4.8
+
+Install boost (we only need headers):
+
+ sudo apt-get install libboost-dev
+
+Install glfw3 dependencies:
+
+ sudo apt-get install cmake libxi-dev libglu1-mesa-dev x11proto-randr-dev x11proto-xext-dev libxrandr-dev x11proto-xf86vidmode-dev libxxf86vm-dev libglu1-mesa-dev freeglut3-dev mesa-common-dev
+
+Install glfw3:
+
+ git clone https://github.com/glfw/glfw.git
+ cd glfw
+ mkdir build
+ cd build
+ cmake ../
+ make
+ sudo make install
+ cd ../../
+
+Build `libllmr`:
-Then open the xcode project and build.
+ git clone git@github.com:mapbox/llmr-native.git
+ cd llmr-native
+ export CXX="g++-4.8"
+ ./configure
+ make
+Note: build will not compile until https://github.com/mapbox/llmr-native/issues/26 is fixed.
# Style protobuf