From 81feb0f386f27e552b8ea3d3ab41cbd7066d7fe7 Mon Sep 17 00:00:00 2001 From: Christopher Eby Date: Mon, 31 Oct 2011 16:52:43 -0500 Subject: [PATCH] More detailed README --- README | 7 ------- README.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 7 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index f2da5f0a..00000000 --- a/README +++ /dev/null @@ -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' diff --git a/README.md b/README.md new file mode 100644 index 00000000..5483dfb6 --- /dev/null +++ b/README.md @@ -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`