summaryrefslogtreecommitdiff
path: root/qpid/java/client/example/src/main/java/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'qpid/java/client/example/src/main/java/README.txt')
-rw-r--r--qpid/java/client/example/src/main/java/README.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/qpid/java/client/example/src/main/java/README.txt b/qpid/java/client/example/src/main/java/README.txt
new file mode 100644
index 0000000000..757054e492
--- /dev/null
+++ b/qpid/java/client/example/src/main/java/README.txt
@@ -0,0 +1,33 @@
+In order to use the runSample script, you are required to set two environment
+variables, QPID_HOME and QPID_SAMPLE. If not the default values will be used.
+
+QPID_HOME
+---------
+This is the directory that contains the QPID distribution. If you are running the Qpid
+Java broker on the same machine as the examples, you have already set QPID_HOME to this
+directory.
+
+default: /usr/share/java/
+
+QPID_SAMPLE
+-----------
+
+This is the examples directory, which is the parent directory of the
+'java' directory in which you find 'runSample.sh'
+
+(Ex:- $QPID_SRC_HOME/java/client/example/src/main)
+
+default: $PWD
+
+Note: you must have write privileges to this directory in order to run
+the examples.
+
+
+Running the Examples
+===========================
+
+To run these programs, do the following:
+
+ 1. Make sure that a Qpid broker is running.
+ 2. In the java directory, use runSample.sh to run the program:
+ $ ./runSample.sh <class name> <arguments> \ No newline at end of file