From f193176c08b198cb7333603df36c85032b6c4367 Mon Sep 17 00:00:00 2001 From: Yves Fischer Date: Thu, 1 Dec 2016 23:37:08 +0100 Subject: Improve README file --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 185457b..0ba54ae 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,26 @@ -Dies ist eine Portierung von iodine (http://code.kryo.se/iodine/) -auf Android +![Logo](src/main/res/drawabe/logo.png) + +This is a port of iodine (http://code.kryo.se/iodine/) to the Android VPN Framework. +It doesn't require "root" on the phone. # Documentation - - (german)[Anwenderdokumentation](doc/anwenderdoku.html) [(PDF)](doc/anwenderdoku.pdf) - - (german)[Entwicklerdokumentation](doc/entwicklerdoku.html) [(PDF)](doc/entwicklerdoku.pdf) +The following two documents exist in German language only: + - [Anwenderdokumentation](doc/anwenderdoku.pdf) + - [Entwicklerdokumentation](doc/entwicklerdoku.pdf) # Building +Requires the Android SDK and NDK to be installed. + ``` bash -(cd jni && ndk-build) -gradle build +./gradlew build ``` +Then find the APK files in folder `build/outputs/apk/` + # Authors and License -Android Iodine Copyright (c) 2013 Yves Fischer +Android Iodine Copyright (c) 2016 Yves Fischer and contributors Same license as iodine. Iodine Copyright (c) 2006-2009 Bjorn Andersson , Erik Ekman -- cgit v1.2.1