summaryrefslogtreecommitdiff
path: root/java/resources/README.txt
diff options
context:
space:
mode:
authorJonathan Robie <jonathan@apache.org>2010-06-23 13:44:50 +0000
committerJonathan Robie <jonathan@apache.org>2010-06-23 13:44:50 +0000
commited440c79f3640259a9912e97f29b91284c8c2292 (patch)
tree14852aa1f8e67bc63ad32153f6f2036d3ebaa597 /java/resources/README.txt
parent5c72228bac33f60c37ae283211090fe2d4a4c740 (diff)
downloadqpid-python-ed440c79f3640259a9912e97f29b91284c8c2292.tar.gz
Changed README to README.txt throughout the project for consistency. Removed gentools/README.txt, which described Velocity.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@957201 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'java/resources/README.txt')
-rw-r--r--java/resources/README.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/java/resources/README.txt b/java/resources/README.txt
new file mode 100644
index 0000000000..1d52d487fb
--- /dev/null
+++ b/java/resources/README.txt
@@ -0,0 +1,40 @@
+
+Documentation
+--------------
+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, once 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
+the configuration files. You can supply a custom configuration using
+the -c argument.
+
+For example:
+
+qpid-server -c ~/etc/config.xml
+
+You can get a list of all command line arguments by using the -h argument.
+
+
+Developing
+----------
+
+In order to build Qpid you need Ant 1.6.5. Use ant -p to list the
+available targets. The default ant target, build, creates a working
+development-mode distribution in the build directory. To run the
+scripts in build/bin set QPID_HOME to the build directory and put
+${QPID_HOME}/bin on your PATH. The scripts in that directory include
+the standard ones in the distribution and a number of testing scripts.
+
+
+