From e9e411c10d4472b18608725cfdd848564f5f8ae3 Mon Sep 17 00:00:00 2001
From: "Rafael H. Schloming" <rhs@apache.org>
Date: Tue, 9 Dec 2008 21:25:03 +0000
Subject: updated README

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@724899 13f79535-47bb-0310-9956-ffa450edef68
---
 qpid/python/README.txt | 62 ++++++++++++++++++++++++++++++++++----------------
 1 file changed, 43 insertions(+), 19 deletions(-)

(limited to 'qpid/python')

diff --git a/qpid/python/README.txt b/qpid/python/README.txt
index e7bb5af408..ba3cbfea92 100644
--- a/qpid/python/README.txt
+++ b/qpid/python/README.txt
@@ -1,32 +1,56 @@
-= RUNNING THE PYTHON TESTS =
+= INSTALLATION =
 
-The tests/ directory contains a collection of python unit tests to
-exercise functions of a broker.
+Extract the release archive into a directory of your choice and set
+your PYTHONPATH accordingly:
+
+  tar -xzf qpid-python-<version>.tar.gz -C <install-prefix>
+  export PYTHONPATH=<install-prefix>/qpid-<version>/python
+
+= GETTING STARTED =
+
+The python client includes a simple hello-world example that publishes
+and consumes a message:
+
+  cp <install-prefix>/qpid-<version>/python/hello-world .
+  ./hello-world
+
+= EXAMPLES =
+
+More comprehensive examples can be found here:
+
+  cd <install-prefix>/qpid-<version>/python/examples
+
+= RUNNING THE TESTS =
+
+The "tests" directory contains a collection of unit tests for the
+python client. The "tests_0-10", "tests_0-9", and "tests_0-8"
+directories contain protocol level conformance tests for AMQP brokers
+of the specified version.
 
 Simplest way to run the tests:
 
- * Run a broker on the default port
+  1. Run a broker on the default port
 
- * ./run-tests
+  2. ./run-tests -s <version>
 
-For additional options: ./run-tests --help
+Where <version> is one of "0-8", "0-9", or "0-10-errata".
 
+See the run-tests usage for for additional options:
 
-== Expected failures ==
+  ./run-tests -h
 
-Until we complete functionality, tests may fail because the tested
-functionality is missing in the broker. To skip expected failures
-in the C++ or Java brokers:
+== Expected failures ==
 
- ./run-tests -I <file_name>
+Certain tests are expected to fail to do incomplete functionality or
+unresolved interop issues. To skip expected failures for the C++ or
+Java brokers:
 
-=== File List ===
+  ./run-tests -I <file_name>
 
-1. cpp_failing_0-10.txt
-2. cpp_failing_0-9.txt
-3. cpp_failing_0-8.txt
-4. java_failing_0-9.txt
-5. java_failing_0-8.txt
-6. cpp_failing_0-10_preview.txt  -- will be depricated soon.
+Where <file_name> is one of the following files:
 
-If you fix a failure, please remove it from the corresponding list.
+  * cpp_failing_0-10.txt
+  * cpp_failing_0-9.txt
+  * cpp_failing_0-8.txt
+  * java_failing_0-9.txt
+  * java_failing_0-8.txt
-- 
cgit v1.2.1