aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2014-03-12 22:10:11 +0100
committerDominik Schürmann <dominik@dominikschuermann.de>2014-03-12 22:10:11 +0100
commitc8c8d8f4b64916dbd3c0890846bb288b02942c0a (patch)
tree93f32cdc64112e06852d5b61caa9427801b5d971
parent0749eef1c557ba9e5f5244fe6e6c94c59d5d2de0 (diff)
parent1df4d4a9e047f70f284183185d81070e49097ad3 (diff)
downloadopen-keychain-c8c8d8f4b64916dbd3c0890846bb288b02942c0a.tar.gz
open-keychain-c8c8d8f4b64916dbd3c0890846bb288b02942c0a.tar.bz2
open-keychain-c8c8d8f4b64916dbd3c0890846bb288b02942c0a.zip
Merge pull request #405 from honnel/checkstyle
Checkstyle configuration information reworked
-rw-r--r--README.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4b997c59f..8954bdcda 100644
--- a/README.md
+++ b/README.md
@@ -156,12 +156,21 @@ See http://source.android.com/source/code-style.html
See http://www.androidpolice.com/2009/11/04/auto-formatting-android-xml-files-with-eclipse/
### Automated syntax check with CheckStyle
-* Paste the tools/checkstyle.xml file to ~/.AndroidStudioPreview/config/codestyles/ (in Linux/Unix)
- or ~/Library/Preferences/AndroidStudioPreview/codestyles (in Mac OSX)
-* Go to Settings (or Preferences in Mac OS X) > Code Style > Java, select OpenPgpChecker,
- as well as Code Style > XML and select OpenPgpChecker again.
-* 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.
+
+####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
OpenPGP Kechain is licensed under GPLv3+.