update the doc

and fix licence
Qwant · Apr 27, 2018 · e7cd9e3 · e7cd9e3
1 parent badc6b8
commit e7cd9e3
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,13 @@ a very cool GL style for Qwant Maps
 
 See https://qwantresearch.github.io/qwant-basic-gl-style/
 
-Use [the map style builder](https://github.com/QwantResearch/map-style-builder) to build it from this repo.
+## Archi
+
+* the `style.json` contains the GL style template
+* the `tileschema_*.json` files contain the tile schema in TileJSON format
+* the icons repository contains all the map icons. You can build a sprite and an icon-font from them with [the map style builder](https://github.com/QwantResearch/map-style-builder)
+* the `i18n.yml` file contains the algorithm to create map in any language (well ... almost any)
+* the `icons.yml` file contains the icons and text color to use for the points of interest. If you uses this file in [the map style builder](https://github.com/QwantResearch/map-style-builder), the text-color and the icons specified in the `style.json` will be overwritten
+
+
+Check out [our map style builder](https://github.com/QwantResearch/map-style-builder) to know more about our build and test process.
diff --git a/ghpages-readme b/ghpages-readme
@@ -7,10 +7,43 @@ a very cool GL style for Qwant Maps
 ![preview](preview/preview-4.png)
 ![preview](preview/thumbnail.png)
 
-## use it
+## Use it
 
-TODO (add some doc)
+Create an HTML page and inclue mapboxgl js viewer. Then point to the style to this file.
 
-## our sprite icons
+```
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset='utf-8' />
+    <title>Test Qwant Basic GL Style</title>
+    <meta name='viewport' content='initial-scale=1,maximum-scale=1,user-scalable=no' />
+    <script src='https://qwantresearch.github.io/qwant-basic-gl-style/mapbox-gl.js'></script>
+    <link href='https://qwantresearch.github.io/qwant-basic-gl-style/mapbox-gl.css' rel='stylesheet' />
+    <style>
+        body { margin:0; padding:0; }
+        #map { position:absolute; top:0; bottom:0; width:100%; }
+    </style>
+</head>
+<body>
+    <div id='map'></div>
+    <script>
+        var map = new mapboxgl.Map({
+            container: 'map',
+            style: 'https://qwantresearch.github.io/qwant-basic-gl-style/style-omt.json',
+            center: [2.33321, 48.86008],
+            hash: true,
+            zoom: 12
+        });
+    </script>
+</body>
+</html>
+```
+
+## Our sprite icons
 
 ![sprite](sprite@2x.png)
+
+## Contribute
+
+[check out this repo](https://github.com/QwantResearch/qwant-basic-gl-style)
diff --git a/package.json b/package.json
@@ -7,5 +7,5 @@
     "gl-style"
   ],
   "author": "Qwant Research",
-  "license": "MIT"
+  "license": "BSD-3"
 }