summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorParménides GV <parmegv@sdf.org>2013-10-24 13:00:57 +0200
committercyBerta <richy@cyborgsociety.org>2013-11-13 00:04:12 +0100
commit73ecf4afa72e43d8ef479dbcdd020b33b7baa943 (patch)
tree0bfe9c916af44b1b12a6651df21d8fd6391f1b60
parent4fcf3d15e5b57c6c1dffd8e7c0cd5b84fda93138 (diff)
Shorter README.
Next commit I'll push the Build from eclipse file. I've also removed the tests .project file because it's not in there, and importing from Eclipse using Git import yielded in an error for the leap_androidTest project.
l---------README2
-rw-r--r--README.md4
-rw-r--r--README.txt63
-rw-r--r--tests/.project34
4 files changed, 3 insertions, 100 deletions
diff --git a/README b/README
index c3ca0746..42061c01 120000
--- a/README
+++ b/README
@@ -1 +1 @@
-README.txt \ No newline at end of file
+README.md \ No newline at end of file
diff --git a/README.md b/README.md
index 61f9346d..d5377737 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ report any bugs or feature requests and to see the list of known issues.
## Building
-The build requires [Ant](https://ant.apache.org/) v1.6+, the [Android SDK](http://developer.android.com/sdk/index.html) and the [Android NDK](http://developer.android.com/tools/sdk/ndk/index.html) r8b
+The build requires [Ant](https://ant.apache.org/) v1.6+, the [Android SDK](http://developer.android.com/sdk/index.html) API 17 and the [Android NDK](http://developer.android.com/tools/sdk/ndk/index.html) r8b
to be installed in your development environment.
In addition you'll need ant/bin, android/tools, 'platforms-tools' and 'android-ndk-r8b' in your enviroment path.
@@ -27,7 +27,7 @@ signed with a different key. Manually uninstall Bitmask Android from your devic
you will then be able to install your own built version.
To uninstall it, do: adb uninstall se.leap.bitmaskclient
-See [here](https://github.com/leapcode/bitmask_android/blob/master/Building_from_eclipse.txt) for
+See [here](https://github.com/leapcode/bitmask_android/blob/master/Building_from_eclipse.md) for
instructions on building from [Eclipse](http://eclipse.org).
## Acknowledgements
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 7a64081c..00000000
--- a/README.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-Compiling
-=========
-
-Preconditions
-----------------
-
-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
------------------------
-
-1. cd $PROJECT_LOCATION/bitmask_android
-2. ./compile.sh
-
-Postconditions
---------------
-
-1. $PROJECT_LOCATION/bitmask_android/bin/Bitmask for Android-debug.apk exists
-
-Running on the emulator
-=========================
-
-Preconditions
------------------
-
-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
-2. Run script: ./run.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
-
-Postconditions
---------------
-
-1. Bitmask for Android is running.
-
-Debugging from console
-======================
-
-Preconditions
------------------
-
-1. run.sh script works
-2. jdb is installed (this program is part of OpenJDK 7)
-
-Instructions to debug from the console
------------------------------------
-
-1. cd $PROJECT_LOCATION/bitmask_android
-2. Run script: ./debug.sh @AVD-NAME . (avd names are the names of the files in ~/.android/avd with extension .avd).
-
-Postconditions
---------------
-
-1. Bitmask for Android is running.
-2. Bitmask for Android does not show the message "Application Bitmask for Android (process se.leap.bitmaskclient) is waiting for the debugger to attach".
-3. You are in a jdb debugging session.
diff --git a/tests/.project b/tests/.project
deleted file mode 100644
index 851db452..00000000
--- a/tests/.project
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
- <name>leap_androidTest</name>
- <comment></comment>
- <projects>
- <project>leap_android</project>
- </projects>
- <buildSpec>
- <buildCommand>
- <name>com.android.ide.eclipse.adt.ResourceManagerBuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>com.android.ide.eclipse.adt.PreCompilerBuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>org.eclipse.jdt.core.javabuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>com.android.ide.eclipse.adt.ApkBuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- </buildSpec>
- <natures>
- <nature>com.android.ide.eclipse.adt.AndroidNature</nature>
- <nature>org.eclipse.jdt.core.javanature</nature>
- </natures>
-</projectDescription>