open-keychain/README.md

129 lines
4.2 KiB
Markdown
Raw Normal View History

2013-01-16 08:45:15 -05:00
# OpenPGP Keychain (for Android)
2012-03-09 06:13:28 -05:00
2013-01-16 08:45:15 -05:00
OpenPGP Keychain is a EXPERIMENTAL fork of Android Privacy Guard (APG)
2012-03-09 06:13:28 -05:00
2012-03-12 11:57:05 -04:00
# Contribute
2013-01-16 08:45:15 -05:00
Fork OpenPGP Keychain and do a merge request. I will merge your changes back into the main project.
2012-03-12 11:57:05 -04:00
2012-09-05 16:41:21 -04:00
# Build
2012-03-12 11:57:05 -04:00
2013-05-25 16:52:44 -04:00
## Build with Gradle
1. Have Android SDK "tools", "platform-tools", and "build-tools" directories in your PATH (http://developer.android.com/sdk/index.html)
2. Export ANDROID_HOME pointing to your Android SDK
2013-05-25 17:14:36 -04:00
3. Install gradle
4. Execute ``gradle wrapper`` (http://www.gradle.org/docs/current/userguide/gradle_wrapper.html)
5. Execute ``./gradlew assemble``
2013-05-25 16:52:44 -04:00
2012-09-05 16:41:21 -04:00
## Build with Ant
2012-03-12 11:57:05 -04:00
2013-01-03 07:09:45 -05:00
1. Have Android SDK "tools" directory in your PATH (http://developer.android.com/sdk/index.html)
2013-05-25 16:52:44 -04:00
2. Execute ``android update project -p OpenPGP-Keychain`` and ``android update project -p libraries/ActionBarSherlock``
3. Execute ``cd OpenPGP-Kechain``, ``ant debug``
2012-09-05 16:41:21 -04:00
## Build with Eclipse
2013-05-25 16:52:44 -04:00
1. File -> Import -> Android -> Existing Android Code Into Workspace, choose "libraries/ActionBarSherlock"
2. File -> Import -> Android -> Existing Android Code Into Workspace, choose "OpenPGP-Keychain"
2013-01-16 08:45:15 -05:00
3. OpenPGP-Kechain can now be build
2012-03-12 11:57:05 -04:00
# Libraries
2013-05-25 16:52:44 -04:00
All JAR-Libraries are provided in this repository under "libs", all Android Library projects are under "libraries".
2012-03-12 11:57:05 -04:00
* ActionBarSherlock to provide an ActionBar for Android < 3.0
* forked Spongy Castle Crypto Lib (Android version of Bouncy Castle)
2012-03-12 11:57:05 -04:00
* android-support-v4.jar: Compatibility Lib
2012-04-12 20:34:46 -04:00
* barcodescanner-android-integration-supportv4.jar: Barcode Scanner Integration
2012-03-09 06:13:28 -05:00
## Build Barcode Scanner Integration
2012-03-09 06:13:28 -05:00
1. Checkout their SVN (see http://code.google.com/p/zxing/source/checkout)
2013-01-03 07:09:45 -05:00
2. Change android-home variable in "build.properties" in the main directory to point to your Android SDK
2012-03-09 06:13:28 -05:00
3. Change directory to android-integration
2012-11-19 16:42:55 -05:00
4. Build using ``ant build``
2013-01-03 07:09:45 -05:00
5. We use "android-integration-supportv4.jar"
2012-03-09 06:13:28 -05:00
On error see: http://code.google.com/p/zxing/issues/detail?id=1207
## Build Spongy Castle
2012-03-09 06:13:28 -05:00
2013-05-18 18:11:14 -04:00
Spongy Castle is the stock Bouncy Castle libraries with a couple of small changes to make it work on Android. OpenPGP-Keychain uses a forked version with some small changes to improve key import speed. These changes have been sent to Bouncy Castle, and Spongy Castle will be used again when they have filtered down.
see
* http://rtyley.github.com/spongycastle/
* https://github.com/ashh87/spongycastle
2012-10-25 08:52:13 -04:00
# Notes
## Eclipse: "GC overhead limit exceeded"
2013-01-16 08:45:15 -05:00
If you have problems starting OpenPGP Kechain from Eclipse, consider increasing the memory limits in eclipse.ini.
See http://docs.oseems.com/general/application/eclipse/fix-gc-overhead-limit-exceeded for more information.
## Generate pressed dashboard icons
2012-03-12 11:57:05 -04:00
1. Open svg file in Inkscape
2012-11-15 17:25:21 -05:00
2. Extensions -> Color -> darker (2 times!)
2013-07-23 16:15:26 -04:00
# Coding Style
## Code
* Indentation: 4 spaces, no tabs
* Maximum line width for code and comments: 100
* Opening braces don't go on their own line
* Field names: Non-public, non-static fields start with m.
* Acronyms are words: Treat acronyms as words in names, yielding !XmlHttpRequest, getUrl(), etc.
See http://source.android.com/source/code-style.html
## XML Eclipse Settings
* XML Maximum line width 999
* XML: Split multiple attributes each on a new line (Eclipse: Properties -> XML -> XML Files -> Editor)
* XML: Indent using spaces with Indention size 4 (Eclipse: Properties -> XML -> XML Files -> Editor)
See http://www.androidpolice.com/2009/11/04/auto-formatting-android-xml-files-with-eclipse/
2012-12-19 08:05:08 -05:00
# Licenses
2013-01-16 08:45:15 -05:00
OpenPGP Kechain is licensed under Apache License v2.
2012-12-19 08:05:08 -05:00
## Libraries
* ActionBarSherlock
http://actionbarsherlock.com/
Apache License v2
* SpongyCastle
https://github.com/rtyley/spongycastle
MIT X11 License
* ZXing QRCode Integration
http://code.google.com/p/zxing/
Apache License v2
* HTMLCleaner
http://htmlcleaner.sourceforge.net/
BSD License
* HtmlSpanner
Apache License v2
## Images
* icon.svg
modified version of kgpg_key2_kopete.svgz
* dashboard_manage_keys.svg, dashboard_my_keys.svg, key.svg
http://rrze-icon-set.berlios.de/
Creative Commons Attribution Share-Alike licence 3.0
* dashboard_decrypt.svg, dashboard_encrypt.svg, dashboard_help.svg
http://tango.freedesktop.org/
Public Domain
* dashboard_scan_qrcode.svg
2013-01-16 08:45:15 -05:00
New creation for OpenPGP Kechain
Apache License v2