aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/j2objc/README.md
diff options
context:
space:
mode:
authorGravatar Dave MacLachlan <dmaclach@google.com>2016-02-03 22:29:27 +0000
committerGravatar David Chen <dzc@google.com>2016-02-04 18:10:45 +0000
commit2f4d1c2583b3fc1ce63d7c5eb678f0717c21db1a (patch)
treebdd6080fa0c89e78329876ccd38fed2636f96fc6 /examples/j2objc/README.md
parent84a0f8c7b56890a6f892c13dcb736805de5a401c (diff)
Get rid of some g3doc warnings.
-- MOS_MIGRATED_REVID=113782855
Diffstat (limited to 'examples/j2objc/README.md')
-rw-r--r--examples/j2objc/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/examples/j2objc/README.md b/examples/j2objc/README.md
index f30a52348a..40a5157f68 100644
--- a/examples/j2objc/README.md
+++ b/examples/j2objc/README.md
@@ -1,11 +1,11 @@
-J2ObjC Examples
-======
+# 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>.
+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.
+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.
@@ -14,4 +14,4 @@ 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
+open to continue working with the application in Xcode.