diff options
| -rw-r--r-- | CONTRIBUTING | 2 | ||||
| -rw-r--r-- | ISSUE_TEMPLATE.md | 7 | ||||
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | doc/README.txt | 44 |
4 files changed, 31 insertions, 32 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index f3c73e32..3310c5b2 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1 +1 @@ -See the README and doc/README.txt for infos about developing and contributing +See the README and doc/README.txt for information about developing and contributing. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 2177edfe..5b80136c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,12 +1,9 @@ -To make issues more manageable, I would appreciate if you fill out the details if applicable +To make issues more manageable, I would appreciate it if you fill out the following details as applicable: # General information 1. Android Version 2. Android Vendor/Custom ROM 3. Device -4. Version of the app (version number/play store version/self built) +4. Version of the app (version number/play store version/self-built) # Description of the issue - - - @@ -15,7 +15,7 @@ Developing --------------- If you want to develop on ics-openvpn please read the [doc/README.txt](https://github.com/schwabe/ics-openvpn/blob/master/doc/README.txt) *before* opening issues or emailing me. -Also please note that before contributing to the project that I would like to retain my ability to relicense the project for different third parties and therefore probably need a contributers agreement from any contributing party. To get started, [sign the Contributor License Agreement](https://www.clahub.com/agreements/schwabe/ics-openvpn). +Also please note that before contributing to the project that I would like to retain my ability to relicense the project for different third parties and therefore probably need a contributer's agreement from any contributing party. To get started, [sign the Contributor License Agreement](https://www.clahub.com/agreements/schwabe/ics-openvpn). You can help ------------ @@ -32,7 +32,7 @@ You make your life and that of your users easier if you embed the certificates i Inline files are supported since OpenVPN 2.1rc1 and documented in the [OpenVPN 2.3 man page](https://community.openvpn.net/openvpn/wiki/Openvpn23ManPage) (under INLINE FILE SUPPORT) -(Using inline certifaces can also make your life on non Android platforms easier since you have only one file.) +(Using inline certifaces can also make your life on non-Android platforms easier since you only have one file.) For example `ca mycafile.pem` becomes ``` @@ -47,12 +47,12 @@ Footnotes ----------- Please note that OpenVPN used by this project is under GPLv2. -If you cannot or do not want to use the Play Store you can [download the apk files directly](http://plai.de/android/) . +If you cannot or do not want to use the Play Store you can [download the apk files directly](http://plai.de/android/). If you want to donate you can donate to [arne-paypal@rfc2549.org via paypal](https://www.paypal.com/cgi-bin/webscr?hosted_button_id=R2M6ZP9AF25LS&cmd=_s-xclick), or alternatively if you believe in fancy Internet money you can use Bitcoin: 1EVWVqpVQFhoFE6gKaqSkfvSNdmLAjcQ9z The old official or main repository was a Mercurial (hg) repository at http://code.google.com/p/ics-openvpn/source/ -The new git repository is now at GitHub under https://github.com/schwabe/ics-openvpn +The new Git repository is now at GitHub under https://github.com/schwabe/ics-openvpn -Please read the doc/README before asking question or starting development. +Please read the doc/README before asking questions or starting development. diff --git a/doc/README.txt b/doc/README.txt index 4c365913..736e368b 100644 --- a/doc/README.txt +++ b/doc/README.txt @@ -1,24 +1,24 @@ ATTENTION ================ -Before doing anything please read the first FAQ point in this file, espicially if -you planing to build commercial software from this client. Also make sure you -understand the licenses of the code. OpenVPN for Android is GPL licensed. You +Before doing anything, please read the first FAQ point in this file, especially if +you plan to build commercial software from this client. Also make sure you +understand the licenses of the code. OpenVPN for Android is GPL-licensed. You _CANNOT_ build a closed sourced custom UI application without acquiring a different (paid) license for UI code. The use of the AIDL API to control OpenVPN for Android from an external app is not subject to the license. The remoteExample project is licensed under the Apache 2.0 license. -When in doubt mail me about it. +When in doubt, mail me about it. -See the file todo.txt for ideas/not yet implemented features (and the bug tracker). +See the file todo.txt for ideas/not-yet-implemented features (and the bug tracker). Build instructions: - Install sdk, ndk, cmake (e.g. with Android studio), swig (3.0+) Fetch the git submodules (the default urls for the submodules use ssh, -setup your own github ssh key or change the url to http in .gitmodules): +set up your own GitHub ssh key or change the url to http in .gitmodules): git submodule init git submodule update @@ -31,6 +31,7 @@ phase to 15 minutes for initial gradle sync are completely normal. The native build should with Windows and Linux but is rarely tested since my main development platform is Mac Os X + FAQ Q: Why are you not answering my questions about modifying @@ -39,13 +40,13 @@ Q: Why are you not answering my questions about modifying A: There are many people building/wanting to build commercial VPN clients on top of my of my client. These client often do not even - honour the license my app or the license of OpenVPN. Even if these - modified software does honour the license I don't like doing unpaid - work/giving advise for free to commerical software developers. - - If you have a legitimate non commercial open source project I will - gladly help you but please understand my initial reservations. + honour the license of my app or the license of OpenVPN. Even if + these modified software do honour the license, I don't like doing + unpaid work/giving advice for free to commercial software + developers. + If you have a legitimate non-commercial open source project, I will + gladly help you, but please understand my initial reservations. Q: How is the OpenVPN version different from normal OpenVPN @@ -53,15 +54,16 @@ A: OpenVPN for Android uses a OpenVPN master branch + dual stack client patches. A git repository of the OpenVPN source code and changes is under: https://github.com/schwabe/openvpn/ -Q: what is minivpn? +Q: What is minivpn? -A: minivpn is only a executable thats links against libopenvpn which - is the normal openvpn build as library. It is done this way so the - Android Play/Store apk will treat the library as normal library and - update it on updates of the application. Also the application does - not need to take care of keeping minivpn up to date because it - contains no code. For almost all intents and purposes minivpn + - libopenvpn.so is the same as the normal openvpn binary +A: minivpn is only a executable that links against libopenvpn, which + is the normal openvpn built as a library. It is done this way so + the Android Play/Store apk will treat the library as a normal + library and update it on updates of the application. Also, the + application does not need to take care of keeping minivpn up to + date because it contains no code. For almost all intents and + purposes minivpn + libopenvpn.so is the same as the normal openvpn + binary. Q: How do I start a VPN by name from an external app? @@ -84,7 +86,7 @@ or from the shell: am start -a android.intent.action.MAIN -n de.blinkt.openvpn/.LaunchVPN -e de.blinkt.openvpn.shortcutProfileName Home -Q: How to control the app from an external app? +Q: How can I control the app from an external app? A: There is an AIDL interface. See src/de/blinkt/openvpn/api/IOpenVPNAPIService.aidl. See the normal Android documentation how to use AIDL. See also the example project under remoteExample. |