[2/2] qpid-jms git commit: update readme with more details

[ro...@apache.org]

update readme with more details


Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/7e1431c1
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/7e1431c1
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/7e1431c1

Branch: refs/heads/master
Commit: 7e1431c1e9e67c43ce19ecab423d7105ddd22b82
Parents: 7f809c8
Author: Robert Gemmell <ro...@apache.org>
Authored: Fri Feb 6 16:43:57 2015 +0000
Committer: Robert Gemmell <ro...@apache.org>
Committed: Fri Feb 6 16:43:57 2015 +0000

----------------------------------------------------------------------
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 41 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/7e1431c1/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 40796b4..79b8d4c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,44 @@
-QpidJMS
-==========
+# QpidJMS
+=========
 
 The QpidJMS project provides a JMS based client that uses the AMQP v1.0 protocol.
 
-Examples of using the client can be found in the qpid-jms-examples module, and
-some basic documentation can be found in the qpid-jms-docs module.
+Below are some quick pointers you might find useful.
+
+## Building the code
+
+The project requires Maven 3. Some example commands follow.
+
+Clean previous builds output and install all modules to local repository without
+running the tests:
+
+    mvn clean install -DskipTests
+
+Install all modules to the local repository after running all the tests:
+
+    mvn clean install
+
+Perform a subset tests on the packaged release artifacts without
+installing:
+
+    mvn clean verify -Dtest=TestNamePattern*
+
+Execute the tests and then produce the code coverage report
+
+    mvn clean test jacoco:report
+
+## Distribution assembly
+
+After building the modules, a distribution assembly can be found at:
+
+    qpid-jms-assemblies/apache-qpid-jms/target
+
+## Examples
+
+First build and install all the modules as detailed above (if running against
+a source checkout/release, rather than against released binaries) and then
+consult the README in the qpid-jms-examples module itself.
+
+## Documentation
+
+There is some basic documentation in the qpid-jms-docs module.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org