More detailed README

This commit is contained in:
Christopher Eby 2011-10-31 16:52:43 -05:00
parent 760e483d22
commit 81feb0f386
2 changed files with 13 additions and 7 deletions

7
README
View File

@ -1,7 +0,0 @@
Vanilla Music Player is a music player for Android
To build, assuming you have the Android SDK installed and in your path:
android update project --path .
ant debug (or ant release)
Javadocs can be generated using 'ant doc'

13
README.md Normal file
View File

@ -0,0 +1,13 @@
Vanilla Music Player is a music player for Android
To build:
* Ensure you have JDK 6 or greater installed and in the path. JDK 6 is required
for @Override annoations for interface methods.
* Ensure you have the Android SDK installed and in your path with platform
android-11 or higher installed.
* Execute `android update project --path .` You must provide a `--target`
parameter as well if you are not using platform 14.
* Execute `ant debug` (or `ant release`)
Javadocs can be generated using `ant doc`