Initial documentation (close #39)

2016-08-23 00:32:09 +02:00
parent 97457a23f2
commit 25c87ccf23
7 changed files with 238 additions and 0 deletions
@@ -0,0 +1,28 @@
+=====
+Usage
+=====
+
+Getting started
+======
+
+::
+
+    Usage: tileserver-gl [mbtiles] [options]
+
+    mbtiles     MBTiles file (uses demo configuration);
+                ignored if the configuration file is also specified
+
+    Options:
+       -c, --config    Configuration file  [config.json]
+       -b, --bind      Bind address
+       -p, --port      Port  [8080]
+       -V, --verbose   More verbose output
+       -v, --version   Version info
+
+
+
+Default styles and configuration
+======
+
+- If no configuration file is specified, the default styles (compatible with osm2vectortiles) are used.
+- If no mbtiles file is specified (and is not found in the current working directory), an extract is downloaded directly from osm2vectortiles.