Browse Source

move config.js from lib to root

Nils Schneider 9 years ago
parent
commit
c48f053619
4 changed files with 28 additions and 6 deletions
  1. 1 0
      .gitignore
  2. 26 5
      README.md
  3. 0 0
      config.js.example
  4. 1 1
      lib/main.js

+ 1 - 0
.gitignore

@@ -2,3 +2,4 @@ bower_components/
 node_modules/
 build/
 .sass-cache/
+config.js

+ 26 - 5
README.md

@@ -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

+ 0 - 0
lib/config.js → config.js.example


+ 1 - 1
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) {