From 4ae222fd980cd566ae0f069e3379da2507fb0857 Mon Sep 17 00:00:00 2001
From: Robert Gemmell <robbie@apache.org>
Date: Mon, 22 Nov 2010 20:49:00 +0000
Subject: add README.txt file for Java client, include in the distributed
 binary convenience archive

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1037881 13f79535-47bb-0310-9956-ffa450edef68
---
 java/client/README.txt | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++
 java/client/build.xml  |  8 +++++++-
 2 files changed, 58 insertions(+), 1 deletion(-)
 create mode 100644 java/client/README.txt

(limited to 'java/client')

diff --git a/java/client/README.txt b/java/client/README.txt
new file mode 100644
index 0000000000..362f86124e
--- /dev/null
+++ b/java/client/README.txt
@@ -0,0 +1,51 @@
+Documentation
+=============
+
+You can access documentation for the client via our website at:
+http://qpid.apache.org/documentation
+
+and via our wiki at:
+http://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Documentation
+
+The client uses the Java Message Service (JMS) 1.1 API, information on which is
+widely available using your favoured search engine.
+
+
+Running the Examples:
+=====================
+
+1. From the client Binary distribution:
+
+From the <installation path>/qpid-client-<version> directory, there are examples
+provided in source form in the example/src sub-directory. These are also
+provided in binary form in the example/lib directory in order that they can be
+run more easily.
+
+E.g, in order to run the Hello example, you would add the client+example library
+files to the java classpath and launch the example like follows:
+
+java -cp "lib/qpid-all.jar:example/lib/qpid-client-examples-<version>.jar" \
+    org.apache.qpid.example.Hello
+
+NOTE: The client uses the SL4FJ API for its logging. You must supply a logging 
+implementation of your choice (eg Log4J) and its associated SLF4J binding, by 
+also adding them to the Java classpath as well as the client libraries 
+themselves. Failure to do so will result in a warning being output and use of
+NoOp logging by the client.
+
+More information on using SLF4J is available at http://www.slf4j.org/manual.html
+which details some of the suipported logging implementations and their
+associted SLF4 bindings as available in the SLF4J distribution.
+
+
+
+2. From the Source distribution / repository:
+
+Run 'ant build' in the parent directory from where this file is stored, ie:
+<installation path>/qpid/java
+
+This will build the various Java modules, leaving binary .jar files output in:
+<installation path>/qpid/java/build/lib
+
+Taking the above the 'distribution directory', consult the README.txt file at:
+<installation path>/qpid/java/client/example/src/main/java
diff --git a/java/client/build.xml b/java/client/build.xml
index 0b8eaccc46..d52de8dca6 100644
--- a/java/client/build.xml
+++ b/java/client/build.xml
@@ -58,7 +58,13 @@
       </copy>
   </target>
 
-  <target name="release-bin-other" depends="release-bin-copy-examples"/>
+  <target name="release-bin-copy-readme">
+      <copy todir="${module.release}" overwrite="true" failonerror="true">
+          <fileset file="${basedir}/README.txt" />
+      </copy>
+  </target>
+
+  <target name="release-bin-other" depends="release-bin-copy-examples,release-bin-copy-readme"/>
 
   <target name="release-bin" depends="release-bin-tasks"/>    
 
-- 
cgit v1.2.1