diff --git a/.gitignore b/.gitignore index c838d6f..71c8c6f 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ bower_components/ node_modules/ build/ .sass-cache/ +config.js diff --git a/README.md b/README.md index 1c6eeef..9158051 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,32 @@ Meshviewer is a frontend for npm install bower install -# Building +# Configure -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. +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. + +## 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 diff --git a/lib/config.js b/config.js.example similarity index 100% rename from lib/config.js rename to config.js.example diff --git a/lib/main.js b/lib/main.js index c057aea..1d12c49 100644 --- a/lib/main.js +++ b/lib/main.js @@ -1,4 +1,4 @@ -define(["config", "moment", "router", "leaflet", "gui", "numeral"], +define(["../config", "moment", "router", "leaflet", "gui", "numeral"], function (config, moment, Router, L, GUI, numeral) { return function () { function handleData(data) {