Add support for running checkstyle after compilation

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
index b01226f..2071e72 100644
--- a/README
+++ b/README
@@ -32,6 +32,34 @@ allprojects {
 
 That should be it.
 
+If you use checkstyle, you can expand the java-mode-hook:
+(add-to-list
+ 'java-mode-hook
+ '(lambda ()
+    (progn
+      (require 'flycheck-android-experimental)
+      (setq flycheck-android-java-checkstyle-jar
+            "tools/checkstyle/checkstyle-6.5-all.jar"
+            flycheck-android-java-checkstyle-path
+            "tools/checkstyle"
+            flycheck-android-java-checkstyle-config
+            "checkstyle-config-android.xml"
+            flycheck-android-java-checkstyle-properties
+            "checkstyle.properties"))))
+
+These are standard flycheck options so there are other ways to set them.
+
+If flycheck-android-java-checkstyle-jar is set checkstyle will be used, if it
+isn't set then the other options are ignored.
+flycheck-android-java-checkstyle-jar and flycheck-android-java-checkstyle-path
+are both relative the project directory.
+flycheck-android-java-checkstyle-config and
+flycheck-android-java-checkstyle-properties are both relative
+flycheck-android-java-checkstyle-path or if it's not set, the project directory.
+All options can be absolute paths.
+If flycheck-android-java-checkstyle-path is set it will be used as working
+directory otherwise the project directory is.
+
 =============================================================================
 For the developer
 =============================================================================