Permalink
Browse files

Documentation update

  • Loading branch information...
1 parent 5c2e9b9 commit 2f9ea675e17586333623617541fb2793ef7b90c5 @jberkel committed Jun 9, 2010
Showing with 10 additions and 5 deletions.
  1. +9 −4 README.markdown
  2. +1 −1 notes/0.4.2.markdown
View
@@ -1,6 +1,6 @@
##Usage
-Requires [sbt](http://simple-build-tool.googlecode.com/)
+Requires [sbt](http://simple-build-tool.googlecode.com/) and the [Android SDK](http://developer.android.com/sdk/index.html) (`brew install android-sdk` when using [homebrew](http://github.com/mxcl/homebrew) on OSX).
To use the plugin in a project, you just need to create project/plugins/Plugins.scala:
@@ -15,19 +15,22 @@ and make the project definition in project/build/Project (for example):
import java.io.File
class Project(info: ProjectInfo) extends AndroidProject(info) {
- override def androidPlatformName = "android-1.5"
+ override def androidPlatformName = "android-2.1"
+
// or preferably set the ANDROID_SDK_HOME environment variable
- override def androidSdkPath = Path.fromFile(new File("/home/mark/code/java/android-sdk-linux_x86-1.5_r2"))
+ override def androidSdkPath = Path.fromFile(new File("/usr/local/Cellar/android-sdk/r5"))
+
// set to the keystore alias you used when creating your keychain
val keyalias = "my_keys"
+
// set to the location of your keystore
override def keystorePath = Path.userHome / ".keystore" / "mykeys.keystore"
}
Alternatively, you can also use a provided script to set everything up for you:
- $ script/create_project MyAndroidProject com.foo.project
+ $ script/create_project myAndroidProject com.foo.project
This will generate the project structure as well as all needed files plus skeleton tests, specs and activities.
@@ -56,6 +59,8 @@ If you need make modifications to the plugin itself, you can compile and install
$ cd android-plugin
$ sbt publish-local
+Because the plugin gets cached in a project based on its version number you might need to use `sbt clean-plugins` to force a reload after `sbt publish-local`.
+
##Credits
This code is based on work by Walter Chang
View
@@ -1,3 +1,3 @@
* Plugin has been renamed to sbt-android-plugin
-* sbt start-emulator command (GH-4) (steve918)
+* sbt start-emulator/device actions (GH-4) (steve918)
* Various proguard config enhancements (GH-9, GH-10, GH-11)

0 comments on commit 2f9ea67

Please sign in to comment.