|
@@ -28,11 +28,32 @@ Meshviewer is a frontend for
|
|
|
npm install
|
|
|
bower install
|
|
|
|
|
|
-# Building
|
|
|
+# Configure
|
|
|
+
|
|
|
+Copy `config.js.example` to `config.js` and change it to match your community.
|
|
|
+
|
|
|
+## dataPath (string)
|
|
|
+
|
|
|
+`dataPath` must point to a directory containing `nodes.json` and `graph.json`
|
|
|
+(both are generated by
|
|
|
+[ffmap-backend](https://github.com/ffnord/ffmap-backend)). Don't forget the
|
|
|
+trailing slash! Data may be served from a different domain with [CORS enabled].
|
|
|
+Also, GZip will greatly reduce bandwidth consumption.
|
|
|
+
|
|
|
+## siteName (string)
|
|
|
+
|
|
|
+Change this to match your communities' name. It will be used in various places.
|
|
|
|
|
|
-You may want to tweak `lib/config.js` to point to your data files. If it's
|
|
|
-served from a different domain, remember to [enable CORS] on your
|
|
|
-webserver. Enabling GZip will reduce bandwidth consumption.
|
|
|
+## mapSigmaScale (float)
|
|
|
+
|
|
|
+This affects the initial scale of the map. Greater values will show a larger
|
|
|
+area. Values like 1.0 and 0.5 might be good choices.
|
|
|
+
|
|
|
+## showContact (bool)
|
|
|
+
|
|
|
+Setting this to `false` will hide contact information for nodes.
|
|
|
+
|
|
|
+# Building
|
|
|
|
|
|
Just run:
|
|
|
|
|
@@ -40,4 +61,4 @@ Just run:
|
|
|
|
|
|
This will generate `build/` containing all required files.
|
|
|
|
|
|
-[enable CORS]: http://enable-cors.org/server.html
|
|
|
+[CORS enabled]: http://enable-cors.org/server.html
|