From debf73aabc6a306f54651ea5e900b366246aa6aa Mon Sep 17 00:00:00 2001
From: John Field <jfield@google.com>
Date: Mon, 27 Jul 2015 14:59:33 +0000
Subject: Update README.md for examples/android to clarify meaning of attribute
 values.

--
MOS_MIGRATED_REVID=99179050
---
 examples/android/README.md | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

(limited to 'examples/android')

diff --git a/examples/android/README.md b/examples/android/README.md
index 9f894f7e4e..c25e53cf2e 100644
--- a/examples/android/README.md
+++ b/examples/android/README.md
@@ -3,17 +3,33 @@ In order to build these examples, add the following two rules to the top-level `
 ```python
 android_sdk_repository(
     name="androidsdk",
-    path="<path to your Android SDK>",
-    api_level=21,
-    build_tools_version="21.1.1")
+    path="<full path to your Android SDK>",
+    api_level=<api level>,
+    build_tools_version="<build tools version>")
 
 android_ndk_repository(
     name="androidndk",
     path="<path to your Android NDK>",
-    api_level=21)
+    api_level=<api_level>)
 ```
-
-Then the following command can be used to build the example app:
+For the `android_sdk_repository` rule, the values of the `api_level` and
+`build_tools_version` attributes correspond, respectively, to directories
+containing specific versions of the `android.jar` file and build tools. For
+example, if `path=/Users/xyzzy/Library/Android/sdk`,
+`api_level=21`, and `build_tools_version="21.1.1"` (note that
+quotes are required in the second case), then your SDK must contain the
+directories
+`/Users/xyzzy/Library/Android/sdk/platforms/android-21` and
+`/Users/xyzzy/Library/Android/sdk/build-tools/21.1.1`.
+
+Similarly, for the `android_ndk_repository` rule, the value of the `api_level`
+attribute corresponds to a directory containing the NDK libraries for that
+API level. For example, if
+`path=/Users/xyzzy/Library/Android/android-ndk-r10e` and
+`api_level=21`, then you your NDK must contain the directory
+`/Users/xyzzy/Library/Android/android-ndk-r10e/platforms/android-21`.
+
+The following command can be used to build the example app:
 
 ```
 bazel build //examples/android/java/bazel:hello_world
-- 
cgit v1.2.3