aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authoruberspot <onexemailx@gmail.com>2014-03-11 23:40:12 +0200
committeruberspot <onexemailx@gmail.com>2014-03-11 23:41:21 +0200
commit317595dc7293dcef132373163298bd08e66e47b4 (patch)
tree9af7c5ad125e28994013de98a304fccb728daeed /README.md
parente8122df35d71bc09013dcc90d35fadbb1126b0cd (diff)
downloadopen-keychain-317595dc7293dcef132373163298bd08e66e47b4.tar.gz
open-keychain-317595dc7293dcef132373163298bd08e66e47b4.tar.bz2
open-keychain-317595dc7293dcef132373163298bd08e66e47b4.zip
Added initial xml and readme info for checkstyle
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 14a9055e9..4b997c59f 100644
--- a/README.md
+++ b/README.md
@@ -155,6 +155,14 @@ 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.
+
## Licenses
OpenPGP Kechain is licensed under GPLv3+.
Some parts (older parts and some libraries are Apache License v2, MIT X11 License)