Changeset 23970 for gs3-extensions/i-jetty/trunk/src/README.txt

Timestamp:

2011-04-29T13:22:22+12:00 (13 years ago)

Author:

davidb

Message:

Mod/improvement to scripts based on fresh round of installing Greenstone on an Android phone

File:

• gs3-extensions/i-jetty/trunk/src/README.txt (modified) (3 diffs)

gs3-extensions/i-jetty/trunk/src/README.txt

@@ -6 +6 @@
 
 It relies on the environment variable ANDROID_SDK_HOME to determine
-where Android's SDK lives on your file system (primarily to be able to
-run 'adb' and 'dex').  If this is not set prior to running the scripts
-this extension provides, it can be set explicitly in setup.bash/bat.
+where the Android SDK lives on your file system, in a similar way
+JAVA_HOME gets used by many programs to determin where Java is
+installed on a particular computer.  The key programs we need to run
+from the Android SDK are 'adb' and 'dex'.  The most straight forward
+way to control this variable is to:
+
+  cp setup-android.bash.in setup-android.bash
+
+and then edit 'setup-android.bash' the value of **ANDROID-SDK-HOME**
+to be the top-level directory of where the Android SDK was installed to.
+
+Having done this, source the main setup file:
+
+  source setup.bash
+
+which automatically sources setup-android.bash if the ANDROID_SDK_HOME
+environment variable isn't set.
 
 Having sourced the setup file the two main steps are:
@@ -19 +33 @@
 The first step typically only needs to be done once. The second step is
 composed of three sub-steps, and may require the last two sub-steps to
-be repeated if the Java code is changed.
+be repeated if the Java code has been modified.
 
 Step 1
@@ -32 +46 @@
 need to have enabled it's application 'Development' mode (under
 Settings->Application)
+
+*************
+**Important**
+*************
+
+Having installed i-jetty, find the application on the Android device
+and launch it (but you don't have to go as far as starting the i-jetty
+server from within this application).  Launching i-jetty completes the
+installation of the application by creating the 'jetty' folder on the
+Android's SD-card, and populating it with the default configuration
+files for i-jetty.  The 'jetty' folder is needed for your setup procedure
+as it is where Greenstone-3 will be installed to.