diff options
| -rw-r--r-- | README.md | 211 |
1 files changed, 3 insertions, 208 deletions
@@ -1,212 +1,7 @@ # OpenKeychain (for Android) -OpenKeychain is an OpenPGP implementation for Android. -For a more detailed description and installation instructions go to http://www.openkeychain.org . +This is a fork of [OpenPGP API](http://github.com/open-keychain/open-keychain) -### 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" +It has been patched to address [this bug](https://github.com/open-keychain/open-keychain/issues/1504) -### Travis CI Build Status of master branch - -[](https://travis-ci.org/open-keychain/open-keychain) - -## How to help the project? - -### Translate the application - -Translations are managed at Transifex, please contribute there at https://www.transifex.com/projects/p/open-keychain/ - -### Contribute Code - -1. Lookout for interesting issues on Github. We have tagged issues were we explicitly like to see contributions: https://github.com/open-keychain/open-keychain/labels/help-wanted -2. Read this README, especially the notes about coding style -3. Fork OpenKeychain and contribute code (the best part :sunglasses: ) -4. Open a pull request on Github. We will help with occuring problems and merge your changes back into the main project. -5. PROFIT - -### For bigger changes - -1. Join the development mailinglist at http://groups.google.com/d/forum/openpgp-keychain-dev -2. Propose bigger changes and discuss the consequences - -I am happy about every code contribution and appreciate your effort to help us developing OpenKeychain! - -## Development - -Development mailinglist at http://groups.google.com/d/forum/openpgp-keychain-dev - -### Build with Gradle - -1. Clone the project from GitHub -2. Get all external submodules with ``git submodule update --init --recursive`` -3. Have Android SDK "tools", "platform-tools", and "build-tools" directories in your PATH (http://developer.android.com/sdk/index.html) -4. Open the Android SDK Manager (shell command: ``android``). -Expand the Tools directory and select "Android SDK Build-tools (Version 21.1.2)". -Expand the Extras directory and install "Android Support Repository" -Select everything for the newest SDK Platform, API 22, and also API 21 -5. Export ANDROID_HOME pointing to your Android SDK -6. Execute ``./gradlew build`` -7. You can install the app with ``adb install -r OpenKeychain/build/outputs/apk/OpenKeychain-debug-unaligned.apk`` - -### Run Tests -1. Use OpenJDK instead of Oracle JDK -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 - -We are using the newest [Android Studio](http://developer.android.com/sdk/installing/studio.html) for development. Development with Eclipse is currently not possible because we are using the new [project structure](http://developer.android.com/sdk/installing/studio-tips.html). - -1. Clone the project from Github -2. Get all external submodules with ``git submodule update --init --recursive`` -3. From Android Studio: File -> Import Project -> Select the cloned top folder - -## Libraries - -### Bouncy Castle - -#### Spongy Castle - -Spongy Castle is the stock Bouncy Castle libraries with a couple of small changes to make it work on Android. OpenKeychain uses a forked version with some small changes. These changes will been sent to Bouncy Castle, and Spongy Castle will be used again when they have filtered down. - -see -* Fork: https://github.com/openpgp-keychain/spongycastle -* Spongy Castle: http://rtyley.github.com/spongycastle/ - -#### Bouncy Castle resources - -* Repository: https://github.com/bcgit/bc-java -* Issue tracker: http://www.bouncycastle.org/jira/browse/BJA - -#### Documentation -* Documentation project at http://www.cryptoworkshop.com/guide/ -* Tests in https://github.com/bcgit/bc-java/tree/master/pg/src/test/java/org/bouncycastle/openpgp/test -* Examples in https://github.com/bcgit/bc-java/tree/master/pg/src/main/java/org/bouncycastle/openpgp/examples -* Mailinglist Archive at http://bouncy-castle.1462172.n4.nabble.com/Bouncy-Castle-Dev-f1462173.html -* Commit changelog of pg subpackage: https://github.com/bcgit/bc-java/commits/master/pg - -## Build System - -We try to make our builds as [reproducible/deterministic](https://blog.torproject.org/blog/deterministic-builds-part-one-cyberwar-and-global-compromise) as possible. - -#### Update Gradle version -* Always use a fixed Android Gradle plugin version not a dynamic one, e.g. ``0.7.3`` instead of ``0.7.+`` (allows offline builds without lookups for new versions, also some minor Android plugin versions had serious issues, i.e. [0.7.2 and 0.8.1](http://tools.android.com/tech-docs/new-build-system)) -* Update every build.gradle file with the new gradle version and/or gradle plugin version - * build.gradle - * OpenKeychain/build.gradle -* run ./gradlew wrapper twice to update gradle and download the new gradle jar file -* commit the corresponding [Gradle wrapper](http://www.gradle.org/docs/current/userguide/gradle_wrapper.html) to the repository (allows easy building for new contributors without the need to install the required Gradle version using a package manager) - -#### Update SDK and Build Tools -* Open build.gradle and change: -``` -ext { - compileSdkVersion = 21 - buildToolsVersion = '21.1.2' -} -``` -* Change SDK and Build Tools in git submodules "openkeychain-api-lib" and "openpgp-api-lib" manually. They should also build on their own without the ext variables. - -#### Add new library -* You can add the library as a Maven dependency or as a git submodule (if patches are required) in the "extern" folder. -* If added as a Maven dependency, pin the library using [Gradle Witness](https://github.com/WhisperSystems/gradle-witness) (Do ``./gradlew -q calculateChecksums`` for Trust on First Use) -* If added as a git submodule, change the ``compileSdkVersion`` and ``buildToolsVersion`` in build.gradle to use the variables from the root project: -``` -android { - compileSdkVersion rootProject.ext.compileSdkVersion - buildToolsVersion rootProject.ext.buildToolsVersion -} -``` -* You can check for wrong ``compileSdkVersion`` by ``find -name build.gradle | xargs grep compileSdkVersion`` - -#### Slow Gradle? - -* https://www.timroes.de/2013/09/12/speed-up-gradle/ -* Disable Lint checking if it is enabled in build.gradle - -#### Error:Configuration with name 'default' not found. - -Gradle project dependencies are missing. Do a ``git submodule init && git submodule update`` - -#### Build on Mac OS X fails? - -Try exporting JAVA_TOOL_OPTIONS="-Dfile.encoding=UTF8" - -## Translations - -Translations are hosted on Transifex, which is configured by ".tx/config". - -1. To pull newest translations install transifex client (e.g. ``apt-get install transifex-client``) -2. Config Transifex client with "~/.transifexrc" -3. Go into root folder of git repo -4. execute ``tx pull -af --skip`` - -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. -* 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 - -### Automated syntax check with CheckStyle - -#### Linux -1. Paste the `tools/checkstyle.xml` file to `~/.AndroidStudioPreview/config/codestyles/` -2. Go to Settings > Code Style > Java, select OpenPgpChecker, as well as Code Style > XML and select OpenPgpChecker again. -3. Start code inspection and see the results by selecting Analyze > Inspect Code from Android-Studio or you can directly run checkstyle via cli with `.tools/checkstyle`. Make sure it's executable first. - -#### Mac OSX -1. Paste the `tools/checkstyle.xml` file to `~/Library/Preferences/AndroidStudioPreview/codestyles` -2. Go to Preferences > Code Style > Java, select OpenPgpChecker, as well as Code Style > XML and select OpenPgpChecker again. -3. Start code inspection and see the results by selecting Analyze > Inspect Code from Android-Studio or you can directly run checkstyle via cli with `.tools/checkstyle`. Make sure it's executable first. - -#### Windows -1. Paste the `tools/checkstyle.xml` file to `C:\Users\<UserName>\.AndroidStudioPreview\config\codestyles` -2. Go to File > Settings > Code Style > Java, select OpenPgpChecker, as well as Code Style > XML and select OpenPgpChecker again. -3. Start code inspection and see the results by selecting Analyze > Inspect Code from Android-Studio. - -## 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/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 -> it under the terms of the GNU General Public License as published by -> the Free Software Foundation, either version 3 of the License, or -> (at your option) any later version. -> -> This program is distributed in the hope that it will be useful, -> but WITHOUT ANY WARRANTY; without even the implied warranty of -> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -> GNU General Public License for more details. -> -> You should have received a copy of the GNU General Public License -> along with this program. If not, see <http://www.gnu.org/licenses/>. - - -### Libraries - -See [In-app about screen](https://github.com/open-keychain/open-keychain/blob/HEAD/OpenKeychain/src/main/res/raw/help_about.md) - -### Images -* 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 +See also [this pull request](https://github.com/open-keychain/openpgp-api/pull/3)
\ No newline at end of file |