[[ LCB Java ]] Add release note

livecodeali · livecodeali · commit db33c1337253 · 2017-02-27T13:22:10.000Z
diff --git a/docs/lcb/notes/feature-java.md b/docs/lcb/notes/feature-java.md
@@ -0,0 +1,15 @@
+# LiveCode Builder Standard Library
+
+## Java utilities
+
+There is now a utility library for manipulating java objects. It contains
+a type JObject which wraps a java object, some type conversion operations:
+
+* StringFromJString - converts a Java string to an LCB String
+* StringToJString - converts an LCB String to a Java string
+* DataFromJByteArray - converts a Java byte array to LCB Data
+* DataToJByteArray - converts LCB Data to a Java byte array
+
+and a utility for determining the class of a given java object:
+
+* GetJavaClassName - return an LCB String containing the class name of the given JObject
diff --git a/libscript/src/java.lcb b/libscript/src/java.lcb
@@ -16,6 +16,19 @@
 
 /**
 This module provides utility handlers for converting to and from Java types.
+
+Description:
+
+> **Important:** This library is currently supported on Android, Mac and
+> Linux. Binding to java classes requires the availability of a Java 
+> runtime and access to the appropriate libraries. On Mac, 
+> the `JAVA_HOME` environment variable must be set to the path to your 
+> Java installation (usually at 
+> `/Library/Java/JavaVirtualMachines/jdk1.7.0_55.jdk/Contents/Home`). 
+> On Linux, your `LD_LIBRARY_PATH` must be set to the folder containing 
+> the `libjvm.so` library (usually at ${JAVA_HOME}/jre/lib/amd64/server)
+> on 64-bit Linux.
+
 */
 module com.livecode.java
 
