diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 17 insertions, 10 deletions
@@ -1,4 +1,4 @@ -# Bitmask Android App +# Bitmask Android App This repository contains the source code for the [Bitmask](https://bitmask.net/) Android app. @@ -19,9 +19,9 @@ Install from developer.android.com: Make sure add the necessary android tools to your bin path. For example, assuming you installed the SDK and NDK to `~/dev` on a linux machine, you would add this to your path: - ~/dev/android-sdk-linux/tools - ~/dev/android-sdk-linux/platform-tools - ~/dev/android-ndk-r10e/ + ~/dev/android-sdk-linux/tools/ + ~/dev/android-sdk-linux/platform-tools/ + ~/dev/android-sdk-linux/ndk-bundle/ Installable via `android` command (SDK Manager): @@ -33,6 +33,7 @@ Finally, install a java compiler. For example: sudo apt-get install default-jdk If you are using a 64-bit machine, you will need to install some libraries too: + sudo apt-get install lib32stdc++6 lib32z1 ## Update git submodules @@ -51,21 +52,23 @@ For that reason, it is necessary to initialize and update them before being able To build NDK sources, you need to issue these commands: - cd app - ./build-native.sh + cd ics-openvpn/main + misc/build-native.sh cd .. (to get back to the project directory) ### Compiling from the command line + #### Signed APK If you want to release a signed APK, you'll have to create a gradle.properties file in the project root with the following structure: - + storeFileProperty=fullPath storePasswordProperty=store password without quotation marks keyAliasProperty=key alias without quotation marks keyPasswordProperty=key password without quotation marks - + #### Actual command + ./gradlew build The resulting apk(s) will be in `app/build/apk`. @@ -77,12 +80,14 @@ The resulting apk(s) will be in `app/build/apk`. ## Running tests To run the automated tests: + 1. Run an emulator (device doesn't necesarily has root, so testVpnCertificateValidator.testIsValid may fail). 2. Unlock Android 3. Issue the command ./gradlew connectedCheck 4. Pay attention and check the "Trust this app" checkbox, if you don't do so tests won't run. Due to the nature of some tests, adb will lose its connectivity and you won't receive any tests results. To look for failed tests, do the following: + 1. adb kill-server 2. adb logcat | less 3. Look for: "failed: test" @@ -94,13 +99,15 @@ We'll polish this process soon, but right now that's what we're doing (well, in cd ics-openvpn git remote add upstream https://github.com/schwabe/ics-openvpn.git git pull --rebase upstream master - -A bunch of conflicts may arise. The guidelines are: + +A bunch of conflicts may arise. The guidelines are: + 1. Methods in HEAD (upstream) completely removed from Bitmask should be removed again (e.g. askPW) 2. Sometimes, Dashboard.class is in Bitmask while in ics-openvpn it is replaced by MainActivity.class and other classes. Keep removing them to keep Dashboard.class in there. 3. Some resources files are stripped from several entries. Remove them if possible (check the code we compile is not using anything else new). ./gradlew updateIcsOpenVpn + ## Acknowledgements This project bases its work in [ics-openvpn project](https://code.google.com/p/ics-openvpn/). |