1 files changed, 45 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ef32d2b
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+=============================================================================
+For the user
+=============================================================================
+First of all, make sure you have flycheck installed.
+
+Download Emacs package from:
+http://www.spawned.biz/flycheck-android/flycheck-android-experimental.tar
+Install using 'package-install-file.
+
+Add the below to your Emacs init file somewhere:
+(add-to-list
+ 'java-mode-hook
+ '(lambda () (require 'flycheck-android-experimental)))
+
+Then, in your root build.gradle, add:
+buildscript {
+    repositories {
+        maven {
+            url uri('http://www.spawned.biz/the_jk/repo')
+        }
+        // ...
+    }
+    dependencies {
+        classpath 'org.thejk:flycheck-android-experimental:0.1'
+        // ...
+    }
+}
+
+allprojects {
+    apply plugin: 'org.thejk.flycheck-android-experimental'
+}
+
+That should be it.
+
+=============================================================================
+For the developer
+=============================================================================
+Two important gradle tasks:
+
+./gradlew uploadArchive
+Build the gradle plugin jar and upload the "../repo" repository by default.
+
+./gradle packageList
+Build the Emacs package placing it in
+build/flycheck-android-experimental-0.1.tar