aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2015-03-16 16:32:13 +0100
committerDominik Schürmann <dominik@dominikschuermann.de>2015-03-16 16:32:13 +0100
commit5d7c1e6fb0ec042066b2b7629961ac165ecf2e20 (patch)
treebc33c7b7c92569558165b973412692f876561367 /README.md
parent146fa8d6c0ace2f9560341171a491e9ddb0361ae (diff)
downloadopen-keychain-5d7c1e6fb0ec042066b2b7629961ac165ecf2e20.tar.gz
open-keychain-5d7c1e6fb0ec042066b2b7629961ac165ecf2e20.tar.bz2
open-keychain-5d7c1e6fb0ec042066b2b7629961ac165ecf2e20.zip
Remove old info from readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 5 insertions, 28 deletions
diff --git a/README.md b/README.md
index 38b486346..964267450 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,8 @@ Development mailinglist at http://groups.google.com/d/forum/openpgp-keychain-dev
### Build with Gradle
+
+Classes can be found under https://github.com/open-keychain/zxing-qr-code. All QR Code related classes were extracted from the ZXing library (https://github.com/zxing/zxing).
1. Get all external submodules with ``git submodule update --init --recursive``
2. Have Android SDK "tools", "platform-tools", and "build-tools" directories in your PATH (http://developer.android.com/sdk/index.html)
3. Open the Android SDK Manager (shell command: ``android``).
@@ -57,33 +59,8 @@ We are using the newest [Android Studio](http://developer.android.com/sdk/instal
1. Clone the project from Github
2. From Android Studio: File -> Import Project -> Select the cloned top folder
-## OpenKeychain's API
-
-OpenKeychain provides two APIs, namely the Intent API and the Remote OpenPGP API.
-The Intent API can be used without permissions to start OpenKeychain's activities for cryptographic operations, import of keys, etc.
-However, it always requires user input, so that no malicious application can use this API without user intervention.
-The Remote OpenPGP API is more sophisticated and allows to to operations without user interaction in the background.
-When utilizing this API, OpenKeychain asks the user on first use to grant access for the calling client application.
-
-More technical information and examples about these APIs can be found in the project's wiki:
-* [Intent API](https://github.com/open-keychain/open-keychain/wiki/Intent-API)
-* [Remote OpenPGP API](https://github.com/open-keychain/open-keychain/wiki/OpenPGP-API)
-
-
## Libraries
-
-### ZXing Barcode Scanner Android Integration
-
-Classes can be found under https://github.com/open-keychain/zxing-android-integration.
-
-1. Copy all classes from https://github.com/zxing/zxing/tree/master/android-integration folder to our git repository.
-
-### ZXing QR-Code Classes
-
-Classes can be found under https://github.com/open-keychain/zxing-qr-code.
-All QR Code related classes were extracted from the ZXing library (https://github.com/zxing/zxing).
-
### Bouncy Castle
#### Spongy Castle
@@ -178,17 +155,17 @@ The full coding style can be found at http://source.android.com/source/code-styl
### Automated syntax check with CheckStyle
-####Linux
+#### 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
+#### 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
+#### 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.