From 60693b02cf88187222ea605258cba82dd8a6025f Mon Sep 17 00:00:00 2001
From: Christopher Baines <cb15g11@soton.ac.uk>
Date: Tue, 16 Sep 2014 08:42:41 +0100
Subject: Documentation improvements

---
 README | 43 ++++++++++++++++++++++---------------------
 1 file changed, 22 insertions(+), 21 deletions(-)

(limited to 'README')

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
-- 
cgit v1.2.3