Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Commit

Permalink
Improve README file
Browse files Browse the repository at this point in the history
  • Loading branch information
yvesf committed Dec 1, 2016
1 parent 52914b0 commit f193176
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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>
Expand Down

0 comments on commit f193176

Please sign in to comment.