aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/android/helloworld/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/android/helloworld/README.md')
-rw-r--r--examples/android/helloworld/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/android/helloworld/README.md b/examples/android/helloworld/README.md
new file mode 100644
index 0000000000..ebb16d136b
--- /dev/null
+++ b/examples/android/helloworld/README.md
@@ -0,0 +1,24 @@
+gRPC on Android
+==============
+
+Note: Building the protobuf dependency for Android requires
+https://github.com/google/protobuf/pull/3878. This fix will be in the next
+protobuf release, but until then must be manually patched in to
+`third_party/protobuf` to build gRPC for Android.
+
+PREREQUISITES
+-------------
+
+- Android SDK
+- Android NDK
+- `protoc` and `grpc_cpp_plugin` binaries on the host system
+
+INSTALL
+-------
+
+The example application can be built via Android Studio or on the command line
+using `gradle`:
+
+ ```sh
+ $ ./gradlew installDebug
+ ```