X-Git-Url: http://git.liburcu.org/?p=lttng-ust.git;a=blobdiff_plain;f=src%2Flib%2Flttng-ust-java%2FREADME.md;fp=src%2Flib%2Flttng-ust-java%2FREADME.md;h=6572579591fc08a1f9d6d8328e7f4d0829c7accb;hp=0000000000000000000000000000000000000000;hb=71ca25096f065a790cd0482d6be15dbc90970bc4;hpb=8091b5d576a6053856e373c27ec0b2bdb01f428f

diff --git a/src/lib/lttng-ust-java/README.md b/src/lib/lttng-ust-java/README.md
new file mode 100644
index 00000000..65725795
--- /dev/null
+++ b/src/lib/lttng-ust-java/README.md
@@ -0,0 +1,22 @@
+<!--
+SPDX-FileCopyrightText: 2010 Pierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+This directory contains a simple API for instrumenting java applications.
+
+Configuration examples to build this library:
+
+dependency: openjdk-7-jdk
+
+    ./configure --enable-jni-interface
+
+Note that the OpenJDK 7 is used for development and continuous integration thus
+we directly support that version for this library. However, it has been tested
+with OpenJDK 6 also. Please let us know if other Java version (commercial or
+not) work with this library.
+
+After building, you can use the liblttng-ust-java.jar file in a Java project.
+It requires the liblttng-ust-java.so* files (which get installed when doing
+`make install') so make sure those are in the linker's library path.