Add local.properties back in as local.properties.sample

Also update the android ReadMe.txt file to include details of this.

2 files changed, 22 insertions, 11 deletions

diff --git a/android/ReadMe.txt b/android/ReadMe.txt
index 55624ea2..2f4ba2a5 100644
--- a/android/ReadMe.txt
+++ b/android/ReadMe.txt
@@ -73,12 +73,15 @@ the top level directory, and that ANT_HOME/bin is on the PATH.
 8) Now we are ready to build mupdf for Android. Check out a copy of MuPDF
 (but you've done that already, cos you're reading this, right?).
 
-9) You will also need a copy of mupdf-thirdparty.zip (see the source code
+9) Copy the android/local.properties.sample file to be
+android/local.properties and edit the contents to match your setup.
+
+10) You will also need a copy of mupdf-thirdparty.zip (see the source code
 link on http://mupdf.com/). Unpack the contents of this into a 'thirdparty'
 directory created within the mupdf directory (i.e. at the same level as
 fitz, pdf, android etc).
 
-10) Finally, you will need a copy of a 'generated' directory. This is not
+11) Finally, you will need a copy of a 'generated' directory. This is not
 currently available to download.
 
 The normal mupdf build process involves running some code on the host
@@ -103,11 +106,11 @@ as simple as running 'make' in the top level directory. Even if the
 make process fails, it should get far enough to generate you the required
 'generated' directory, and you can continue through these instructions.
 
-11) Change into the android directory, and edit local.properties into your
+12) Change into the android directory, and edit local.properties into your
 favourite editor. Change the sdk path there as appropriate. This should be
 the only bit of localisation you need to do.
 
-12) Change into the android directory (note, the android directory, NOT
+13) Change into the android directory (note, the android directory, NOT
 the android/jni directory!), and execute (in a Cygwin window on Windows!):
 
        ndk-build
@@ -125,7 +128,7 @@ to
 
 and this should solve the problem.
 
-13) Then execute:
+14) Then execute:
 
        ant debug
 
@@ -135,30 +138,30 @@ or on windows under cygwin:
 
 This should build the java wrapper.
 
-14) Now start the emulator by executing:
+15) Now start the emulator by executing:
 
        emulator -avd FroyoEm
 
 This will take a while to full start up (be patient).
 
-15) We now need to give the demo file something to chew on, so let's copy
+16) We now need to give the demo file something to chew on, so let's copy
 a file into the SD card image of the emulator (this should only need to be
 done once). With the emulator running type:
 
        adb push ../../MyTests/pdf_reference17.pdf /mnt/sdcard/Download/test.pdf
 
 (where obviously ../../MyTests/pdf_reference17.pdf is altered for your
-machine, and  under Windows, should start c:/ even if invoked from cygwin) (adb lives
-in <sdk>/platform-tools if it's not on your path).
+machine, and  under Windows, should start c:/ even if invoked from cygwin)
+(adb lives in <sdk>/platform-tools if it's not on your path).
 
-16) With the emulator running (see step 14), execute
+17) With the emulator running (see step 14), execute
 
        ant debug install
 
 ('ant.bat debug install' on Windows) and that will copy MuPDF into the
 emulator where you can run it from the launchpad screen.
 
-17) To see debug messages from the emulator (including stdout/stderr from
+18) To see debug messages from the emulator (including stdout/stderr from
 our app), execute:
 
        adb logcat
diff --git a/android/local.properties.sample b/android/local.properties.sample
new file mode 100644
index 00000000..557fbc14
--- /dev/null
+++ b/android/local.properties.sample
@@ -0,0 +1,8 @@
+# Uncomment and edit the appropriate line below.
+# Resave this file as local.properties.
+
+# For MacOS/Linux you want a line such as:
+#sdk.dir=/Library/android-sdk-mac_x86
+
+# For Windows/Cygwin you want something like the following:
+#sdk.dir=C:\\Program Files (x86)\\Android\\android-sdk