aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README13
1 files changed, 7 insertions, 6 deletions
diff --git a/README b/README
index fd65d1a..0a835e8 100644
--- a/README
+++ b/README
@@ -11,22 +11,23 @@ The FixMyStreet mobile app uses PhoneGap and has versions for Android and iOS.
Running
-------
-To get it up and running you will need to create a config.js file in www/js/ based
-on the www/js/config-example.js file. This has configuration for which FMS instance
+To get it up and running you will need to create a config.js file in src/js/ based
+on the src/js/config-example.js file. This has configuration for which FMS instance
to use etc.
You should then be able to build and run it like any other PhoneGap project.
-The app works out which version of the PhoneGap JavaScript file to use and loads
-it dynamically - see www/cordova-independant.js for details.
+The platform specific cordova.js files are inside the projects and then the src directory
+is included inside the www folders for each platform. On Android this is done with a
+symbolic link, on iOS by a build script.
Basic structure
---------------
Android - android project
iPhone - iOS version
-www - JS, HTML, CSS and image files
+src - JS, HTML, CSS and image files
-www Stucture
+src Stucture
------------
css - css files
js - project javascript files