summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorParménides GV <parmegv@sdf.org>2013-10-17 19:51:48 +0200
committercyBerta <richy@cyborgsociety.org>2013-11-13 00:04:12 +0100
commit3f4c8e4fcba83caa02b1eb98aa4b574b61da33b6 (patch)
treec1b2717ed7d2cc0f14401190b32fcb142c93f143
parenta966c05bcc06a2af838d4e1e766b779c2245c4ce (diff)
Each step refers to the previous one.
Instead of repeating preconditions, or composing sentences which take some things as obvious (e.g., the android client can be compiled using eclipse, but that does not mean that the run.sh script will work), I refer each step to the previous one.
-rw-r--r--README.txt20
1 files changed, 9 insertions, 11 deletions
diff --git a/README.txt b/README.txt
index 1246e5e7..7a64081c 100644
--- a/README.txt
+++ b/README.txt
@@ -4,9 +4,10 @@ Compiling
Preconditions
----------------
-1. Android SDK installed (follow instructions from http://developer.android.com/sdk/index.html)
-2. API version 15 installed.
-2. Ant 1.6 or greater
+1. Android SDK installed (follow instructions from http://developer.android.com/sdk/index.html).
+2. Android SDK tools and platform-tools reachable within $PATH
+3. API version 15 installed.
+4. Ant 1.6 or greater
Instructions to compile
-----------------------
@@ -25,15 +26,14 @@ Running on the emulator
Preconditions
-----------------
-1. Android SDK is installed, and its tools are in the PATH.
-2. Bitmask for Android has been compiled.
-3. An avd exists in ~/.android/avd/ (if you do not have one, follow instructions from http://developer.android.com/tools/devices/managing-avds-cmdline.html)
+1. compile.sh script works.
+2. An avd exists in ~/.android/avd/ (if you do not have one, follow instructions from http://developer.android.com/tools/devices/managing-avds-cmdline.html)
Instructions to run on the emulator
-----------------------------------
1. cd $PROJECT_LOCATION/bitmask_android
-1. Run script: ./run.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
+2. Run script: ./run.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
Postconditions
--------------
@@ -46,10 +46,8 @@ Debugging from console
Preconditions
-----------------
-1. Android SDK is installed, and its tools are in the PATH.
-2. Bitmask for Android has been compiled in the debugging machine.
-3. An avd exists in ~/.android/avd/ (if you do not have one, follow instructions from http://developer.android.com/tools/devices/managing-avds-cmdline.html).
-4. jdb is installed (this program is part of OpenJDK 7)
+1. run.sh script works
+2. jdb is installed (this program is part of OpenJDK 7)
Instructions to debug from the console
-----------------------------------