summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYves Fischer <yvesf-git@xapek.org>2016-12-01 23:37:08 +0100
committerYves Fischer <yvesf-git@xapek.org>2016-12-01 23:38:18 +0100
commita53a746d98731eae60b43c35451d3917ff44aea6 (patch)
tree8643d847de26ebf125f9556b6abc42a8ce7b2332 /README.md
parent52914b0f7bffed0649372254268b7a07a42b1448 (diff)
downloadandiodine-improve-docs.tar.gz
andiodine-improve-docs.zip
Improve README fileimprove-docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files 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 <yvesf+andiodine@xapek.org>
+Android Iodine Copyright (c) 2016 Yves Fischer <yvesf+andiodine@xapek.org> and contributors
Same license as iodine.
Iodine Copyright (c) 2006-2009 Bjorn Andersson <flex@kryo.se>, Erik Ekman <yarrick@kryo.se>