summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom MacWright <tom@macwright.org>2014-01-27 12:58:27 -0500
committerTom MacWright <tom@macwright.org>2014-01-27 12:58:27 -0500
commit218b92b88366f3ac29c48229c56b20c8fbbe1367 (patch)
treebba68bafa5034603ad5d3220c394d8a93dd78ec9 /README.md
parent64dbfdce01d865f4c8dbf5ad0f65a66a61621383 (diff)
downloadqtlocation-mapboxgl-218b92b88366f3ac29c48229c56b20c8fbbe1367.tar.gz
Improve readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 58779708f5..e6a573456a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,16 @@
-
+An OpenGL renderer for [Mapbox vector tiles](https://www.mapbox.com/blog/vector-tiles),
+implemented in C++, targeting iOS & OSX.
# Build instructions
## Mac OS X
+You may need to install [glfw3](http://www.glfw.org/docs/latest/):
+
+```
+brew install homebrew/versions/glfw3
+```
+
```
mkdir xcode
cd xcode
@@ -13,7 +20,6 @@ cmake .. -G Xcode
Then open the xcode project and build.
-
# Style protobuf
We're encoding the styling information as a protocol buffer, according to