aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/j2objc/README.md
diff options
context:
space:
mode:
authorGravatar Michael Thvedt <mthvedt@google.com>2015-08-12 18:09:52 +0000
committerGravatar Florian Weikert <fwe@google.com>2015-08-13 14:01:23 +0000
commit583c356d5b5d01516ba07e79ae54c7fd3769ebfb (patch)
tree60ea3cc17262431d4b8e6070f32662fb307ca05b /examples/j2objc/README.md
parent828a4bee6007849c51c56ff0f17040f036ddae38 (diff)
Open-source full support for J2ObjC in Bazel, including dead code removal, and add an example.
-- MOS_MIGRATED_REVID=100493818
Diffstat (limited to 'examples/j2objc/README.md')
-rw-r--r--examples/j2objc/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/j2objc/README.md b/examples/j2objc/README.md
new file mode 100644
index 0000000000..f30a52348a
--- /dev/null
+++ b/examples/j2objc/README.md
@@ -0,0 +1,17 @@
+J2ObjC Examples
+======
+
+J2ObjC is an open-source tool that can transpile Java code to Objective-C code,
+which can then be used by dependent Objective-C code. The J2ObjC repository can be found at
+<https://github.com/google/j2objc>.
+
+The example in this directory shows a simple use of J2Objc with a Java library and an iOS app.
+Because it builds an iOS application it can only be run on Mac OSX.
+Here, a java_library is transpiled to Objective-C via j2objc_library.
+We can then have an objc_library call upon this library.
+
+Build the top-level application with
+`bazel build examples/j2objc:J2ObjcExample`, which when finished emits the
+path to a generated .ipa which you can then install to your test device. The
+same build will also emits the path to an Xcode project directory which you can
+open to continue working with the application in Xcode. \ No newline at end of file