First round of comments.

This resolves the first step from issue #2908.

Next step: Put user message strings into an appropiate place.

1 files changed, 65 insertions, 1 deletions

diff --git a/README b/README
index c3ca074..7d57a6e 120000..100644
--- a/README
+++ b/README
@@ -1 +1,65 @@
-README.txt
\ No newline at end of file
+Compiling
+=========
+
+Preconditions
+----------------
+
+1. Android SDK installed (follow instructions from http://developer.android.com/sdk/index.html)
+2. API version 16 or version installed.
+2. Ant 1.6 or greater
+
+Instructions to compile
+-----------------------
+
+1. cd $PROJECT_LOCATION/leap_android
+2. ./compile.sh
+
+Postconditions
+--------------
+
+1. $PROJECT_LOCATION/leap_android/bin/LEAP Android-debug.apk exists
+
+Running on the emulator
+=========================
+
+Preconditions
+-----------------
+
+1. Android SDK is installed, and its tools are in the PATH.
+2. leap_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)
+
+Instructions to run on the emulator
+-----------------------------------
+
+1. cd $PROJECT_LOCATION/leap_android
+1. Run script: ./run.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
+
+Postconditions
+--------------
+
+1. LEAP Android is running.
+
+Debugging from console
+======================
+
+Preconditions
+-----------------
+
+1. Android SDK is installed, and its tools are in the PATH.
+2. leap_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).
+4. jdb is installed (this program is part of OpenJDK 7)
+
+Instructions to debug from the console
+-----------------------------------
+
+1. cd $PROJECT_LOCATION/leap_android
+2. Run script: ./debug.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
+
+Postconditions
+--------------
+
+1. LEAP Android is running.
+2. LEAP Android does not show the message "Application LEAP for Android (process se.leap.leapclient) is waiting for the debugger to attach".
+3. You are in a jdb debuggin session.