summaryrefslogtreecommitdiff
path: root/java/resources/README
diff options
context:
space:
mode:
authorMartin Ritchie <ritchiem@apache.org>2007-08-30 12:19:31 +0000
committerMartin Ritchie <ritchiem@apache.org>2007-08-30 12:19:31 +0000
commit61a61c3716e42bf175004049976391407f28704d (patch)
tree8ab343c1941a7565532189763dc79473a10beb3c /java/resources/README
parente183227707d150b1f42e750df0e90cd7dac8744e (diff)
downloadqpid-python-61a61c3716e42bf175004049976391407f28704d.tar.gz
Remerge of M2. All tests pass locally
Testing done in Intelij and mvn command line via windows/cygwin. Python tests removed from auto build pending Jython-siztion. Tested running broker in intelij and python run-tests from cygwin. All tests pass. (CombinedTest still exhibts a race condition. but that has always been so.) Additional Race condition identified (around MsgReject/AutoDeleteQueues) during testing patch to follow. systests are inconsistent Some use TestableMemoryMessageStore some use MemoryMessgaeStore. Lets not roll back this change if issues are discovered. Lets work together to go forward and address any issues. I have spent a lot of time ensuring the tests work for me so I hope that they work for you. git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@571129 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'java/resources/README')
-rw-r--r--java/resources/README40
1 files changed, 40 insertions, 0 deletions
diff --git a/java/resources/README b/java/resources/README
new file mode 100644
index 0000000000..1d52d487fb
--- /dev/null
+++ b/java/resources/README
@@ -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.
+
+
+