aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher Baines <cb15g11@soton.ac.uk>2014-09-16 08:42:41 +0100
committerChristopher Baines <cb15g11@soton.ac.uk>2014-09-16 08:42:41 +0100
commit60693b02cf88187222ea605258cba82dd8a6025f (patch)
tree7b9d1596e32c96df9357632fb74225bd5b5e79cb
parent94990194cdec4f4f9348d2323a80004e6fc82f25 (diff)
downloadmaps.southampton.ac.uk-60693b02cf88187222ea605258cba82dd8a6025f.tar
maps.southampton.ac.uk-60693b02cf88187222ea605258cba82dd8a6025f.tar.gz
Documentation improvements
-rw-r--r--README43
-rwxr-xr-xdownload-libraries.sh7
2 files changed, 29 insertions, 21 deletions
diff --git a/README b/README
index dc1eebb..f80b486 100644
--- a/README
+++ b/README
@@ -1,7 +1,25 @@
# Building
-First build all the libraries, described below, then run:
+First pull in the submodules:
+
+ git submodule update --init
+ cd libraries/leaflet-soton
+ git submodule update --init
+
+Then, either run, or build jquery and leaflet from source:
+
+ ./download-libraries.sh
+
+After this, you will need to fetch or build the data.json file. Either running:
+
+ ./create-data.js # if you have a local OSM database
+
+ OR
+
+ wget http://maps.southampton.ac.uk/data.json -O libraries/leaflet-soton/data.json
+
+Then run:
grunt
@@ -11,20 +29,13 @@ Or, to build for release (with smaller js and css files):
# Building the libraries
+Most of the libraries do not require building, but jquery and leaflet do.
+
## jquery
npm run build
-## bootstrap
-
- npm install
- grunt dist
-
-## leaflet-soton
-
- git submodule update --init
-
-### leaflet
+## leaflet
npm install -g jake
npm install
@@ -33,13 +44,3 @@ 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
diff --git a/download-libraries.sh b/download-libraries.sh
new file mode 100755
index 0000000..f01a64f
--- /dev/null
+++ b/download-libraries.sh
@@ -0,0 +1,7 @@
+#!/bin/bash -x
+
+mkdir -p libraries/jquery/dist/
+wget http://code.jquery.com/jquery-2.1.1.js -O libraries/jquery/dist/jquery.js
+
+wget http://leaflet-cdn.s3.amazonaws.com/build/leaflet-0.7.3.zip -O libraries/leaflet-0.7.3.zip
+unzip -o libraries/leaflet-0.7.3.zip -d libraries/leaflet-soton/resources/leaflet/dist