Initial commit

1 files changed, 45 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..dc1eebb
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+
+# Building
+
+First build all the libraries, described below, then run:
+
+    grunt
+
+Or, to build for release (with smaller js and css files):
+
+    grunt release
+
+# Building the libraries
+
+## jquery
+
+    npm run build
+
+## bootstrap
+
+    npm install
+    grunt dist
+
+## leaflet-soton
+
+    git submodule update --init
+
+### leaflet
+
+    npm install -g jake
+    npm install
+
+This requires a local OSM database, and to setup config.json (use the template
+config.json.default).
+
+    ./create-data.js
+
+## list.js
+
+    npm install
+    grunt dist
+
+## typeahead.js
+
+    npm install
+    grunt