summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarnie McCormack <marnie@apache.org>2006-11-10 15:05:17 +0000
committerMarnie McCormack <marnie@apache.org>2006-11-10 15:05:17 +0000
commit0a5fed7febf969dcf2099c13adae0ae8f47a872e (patch)
treee6fd41e7a55757aed90162a60a13d64b9387dfb7
parent5826809cce765ba21639f828fdb5d2037b06a0c0 (diff)
downloadqpid-python-0a5fed7febf969dcf2099c13adae0ae8f47a872e.tar.gz
update to readme
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid/java@473359 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--README.txt24
1 files changed, 21 insertions, 3 deletions
diff --git a/README.txt b/README.txt
index bf41dc4fd3..2d646645fd 100644
--- a/README.txt
+++ b/README.txt
@@ -1,10 +1,26 @@
+All of our user documentation for the Qpid Java components can be accessed on our
+wiki at:
+
+http://cwiki.apache.org/confluence/display/qpid/Qpid+Java+Documentation
+
+This includes a Getting Started Guide and FAQ as well as detailed developer documentation.
+
+However, here's a VERY quick guide to running the installed Qpid broker, omce you have installed it somewhere !
+
Running the Broker
------------------
To run the broker, set the QPID_HOME environment variable to
-distribution directory and add $QPID_HOME/bin to your PATH. Then run
-the qpid-server shell script or qpid-server.bat batch file to start
-the broker. By default, the broker will use $QPID_HOME/etc to find
+distribution directory and add $QPID_HOME/bin to your PATH.
+
+Then run the qpid-server shell script or qpid-server.bat batch file to start
+the broker.
+
+You can then start the broker:
+
+qpid-server
+
+By default, the broker will use $QPID_HOME/etc to find
the configuration files. You can supply a custom configuration using
the -c argument.
@@ -14,3 +30,5 @@ qpid-server -c ~/etc/config.xml
You can get a list of all command line arguments by using the -h argument.
+Note that the Qpid broker needs JDK 1.5 or later.
+