Merge lp:~nmb/bzr-testrunner/update-docs-for-plugin-guide into lp:bzr-testrunner

[Neil Martinsen-Burrell]

[Neil Martinsen-Burrell (nmb)]

This improves the documentation so that it can easily be included in the Bazaar Plugins Guide.

=== modified file 'README'
--- README	2009-04-22 14:31:59 +0000
+++ README	2009-11-13 16:15:20 +0000
@@ -1,28 +1,39 @@
---------------------
-   bzr-testrunner   
---------------------
-
-This is a "Poor man's PQM" that will run a command specified branch.conf and
-only allow new changes in the branch if the return code of that command is 0.
-It is intended to run a testsuite and verify that it passes before allowing
-commits and pushes, but it should have no problem running any arbitrary command.
+==============
+bzr-testrunner
+==============
+
+This is a "Poor man's PQM" (https://launchpad.net/pqm) that will run a command
+specified in branch.conf and only allow new changes in the branch if the return
+code of that command is 0.  It is intended to run a test suite and verify that
+it passes before allowing commits and pushes, but it should have no problem
+running any arbitrary command.
+
+Installation
+------------
+
+To install the plugin, simply use Bazaar to branch this directory into your
+Bazaar plugins directory (usually ~/.bazaar/plugins)::
+
+  $ cd ~/.bazaar/plugins
+  $ bzr branch lp:bzr-testrunner testrunner
+
 
 Usage
----------
+-----
 
-1) Install to bazaar plugins.
-2) Set 'pre_change_branch_tip_test_command' to the command you'd like to run in branch.conf.
-3) You're done.  When a commit or push is made, the latest code will be
-   exported to a temporary directory and the test command will be run.
+Set 'pre_change_branch_tip_test_command' to the command you'd like to run in
+branch.conf.  When you make a commit, the command specified here will be run in
+a temporary directory with the new code.  If the command does not return 0,
+then the commit will not run.
 
 TODO
----------
+----
 
 * Parameterize messages
 * Check across protocols... tested on local branches and bzr+ssh so far
 
 Authors
----------
+-------
 
 james_w
 phinze
 
=== modified file '__init__.py'
--- __init__.py	2009-04-22 14:32:09 +0000
+++ __init__.py	2009-11-13 16:15:20 +0000
@@ -1,4 +1,29 @@
-"""Run a command before allowing a commit."""
+"""Run a command before allowing a commit.
+
+This is a "Poor man's PQM" (https://launchpad.net/pqm) that will run a command
+specified in branch.conf and only allow new changes in the branch if the return
+code of that command is 0.  It is intended to run a test suite and verify that
+it passes before allowing commits and pushes, but it should have no problem
+running any arbitrary command.
+
+Installation
+------------
+
+To install the plugin, simply use Bazaar to branch this directory into your
+Bazaar plugins directory (usually ~/.bazaar/plugins)::
+
+  $ cd ~/.bazaar/plugins
+  $ bzr branch lp:bzr-testrunner testrunner
+
+
+Usage
+-----
+
+Set 'pre_change_branch_tip_test_command' to the command you'd like to run in
+branch.conf.  When you make a commit, the command specified here will be run in
+a temporary directory with the new code.  If the command does not return 0,
+then the commit will not run.
+"""
 
 import sys
 import os