summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKonstantin Käfer <github@kkaefer.com>2014-01-08 12:13:46 +0100
committerKonstantin Käfer <github@kkaefer.com>2014-01-08 12:13:46 +0100
commit7253f808c6eda60fc76547faf165b329a1fd99bc (patch)
tree9c11f99be4eec0eb309bbce2602f4fe7448ef0c4 /README.md
parent4f8556a6b80c41df8f8842a36ce13274c27b9ceb (diff)
downloadqtlocation-mapboxgl-7253f808c6eda60fc76547faf165b329a1fd99bc.tar.gz
add readme info about protobuf styles
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 47db97996c..10f5148262 100644
--- a/README.md
+++ b/README.md
@@ -28,3 +28,17 @@ In `system/include/GL/glfw.h`, replace the wheel callback typedef with
```c
typedef void (GLFWCALL * GLFWmousewheelfun)(float);
```
+
+
+
+# Style protobuf
+
+We're encoding the styling information as a protocol buffer, according to
+proto/style.proto. The reason for doing so is that we don't have to ship with a
+JSON/yaml parser. To test the conversion script, run
+
+```
+bin/convert-style.js | protoc --decode=style proto/style.proto
+```
+
+You should see a nicely formatted hierarchical output of the converted style.