aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Hammann <github@honnel.de>2014-03-12 21:36:42 +0100
committerDaniel Hammann <github@honnel.de>2014-03-12 21:36:42 +0100
commit5eb12ef88f93bfadb51ac28e31bcf4935647b827 (patch)
tree4c60f9515eba5036029f74703032e932aeaba7de
parent6ca58dd2116dd8c0e23826fc3361c251da530df8 (diff)
downloadopen-keychain-5eb12ef88f93bfadb51ac28e31bcf4935647b827.tar.gz
open-keychain-5eb12ef88f93bfadb51ac28e31bcf4935647b827.tar.bz2
open-keychain-5eb12ef88f93bfadb51ac28e31bcf4935647b827.zip
Squashed commit of the following:
commit 1df4d4a9e047f70f284183185d81070e49097ad3 Author: Daniel Hammann <github@honnel.de> Date: Wed Mar 12 21:33:13 2014 +0100 Added Windows section to CheckStyle configuration information part (and splitted Linux and MacOSX up).
-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+.