diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 19 insertions, 24 deletions
@@ -1,17 +1,15 @@ -# Branch Description - -This is Valodim's topic branch for linked identities in OpenKeychain. -Everything here is very much work-in-progress and subject to changes. -Specification will follow. - # OpenKeychain (for Android) OpenKeychain is an OpenPGP implementation for Android. For a more detailed description and installation instructions go to http://www.openkeychain.org . -### Travis CI Build Status of development branch +### Branches +* The development of OpenKeychain happens in the "master" branch. +* For every release a new branch, e.g., "3.2-fixes" is created to backport fixes from "master" + +### Travis CI Build Status of master branch -[](https://travis-ci.org/open-keychain/open-keychain) +[](https://travis-ci.org/open-keychain/open-keychain) ## How to help the project? @@ -53,7 +51,12 @@ Select everything for the newest SDK Platform, API 22, and also API 21 ### Run Tests 1. Use OpenJDK instead of Oracle JDK -2. Execute ``./gradlew test`` +2. Execute ``./gradlew clean testDebug --continue`` + +### Run Jacoco Test Coverage +1. Use OpenJDK instead of Oracle JDK +2. Execute ``./gradlew clean testDebug jacocoTestReport`` +3. Report is here: OpenKeychain/build/reports/jacoco/jacocoTestReport/html/index.html ### Development with Android Studio @@ -148,12 +151,13 @@ see http://help.transifex.net/features/client/index.html#user-client ## 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 +* 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. * Fully Qualify Imports: Do *not* use wildcard-imports such as ``import foo.*;`` +* Android Studio warnings should be fixed, or suppressed if they are incorrect. The full coding style can be found at http://source.android.com/source/code-style.html @@ -176,7 +180,7 @@ The full coding style can be found at http://source.android.com/source/code-styl ## Licenses OpenKechain is licensed under GPLv3+. -The full license text can be found in the [LICENSE file](https://github.com/open-keychain/open-keychain/blob/master/LICENSE). +The full license text can be found in the [LICENSE file](https://github.com/open-keychain/open-keychain/blob/HEAD/LICENSE). Some parts and some libraries are Apache License v2, MIT X11 License (see below). > This program is free software: you can redistribute it and/or modify @@ -195,23 +199,14 @@ Some parts and some libraries are Apache License v2, MIT X11 License (see below) ### Libraries -See https://github.com/open-keychain/open-keychain/blob/development/OpenKeychain/src/main/res/raw/help_about.md +See [In-app about screen](https://github.com/open-keychain/open-keychain/blob/HEAD/OpenKeychain/src/main/res/raw/help_about.md) ### Images -* icon.svg - modified version of kgpg_key2_kopete.svgz - * Actionbar icons http://developer.android.com/design/downloads/index.html#action-bar-icon-pack - + * QR Code Actionbar icon https://github.com/openintents/openintents/blob/master/extensions/qrcode_ext/icons/ic_menu_qr_code/ic_menu_qr_code_holo_light/ic_menu_qr_code.svg * Key status icons by the ModernPGP working group https://github.com/ModernPGP - -* Purple color scheme - http://android-holo-colors.com/ - -* DNS icon - http://www.fatcow.com/free-icons |