summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorchipx86 <chipx86@5efc13c4-1f27-0410-8691-ff2d1f55687e>2009-03-27 08:43:26 +0000
committerchipx86 <chipx86@5efc13c4-1f27-0410-8691-ff2d1f55687e>2009-03-27 08:43:26 +0000
commitf5ec35fc2606a89034823ab15ccefb7e5bbe15c8 (patch)
tree6f1dc60321a971d437efc2739df6dfee412f5fbc /README
Move post-review into a new top-level "rbtools" package
Since the dawn of time, post-review has lived in the Review Board tree, despite being a client script and not necessarily being needed on the server. This moves post-review into a new rbtools package, which users will be able to easy_install (easy_install -U RBTools). The simplejson dependency will be fetched, and users won't have to go hunting in SVN for a script. Over time, I'd like to add new scripts into here (such as one to apply a diff from a review request), and further down the road I'd like to create an "rbapi" (or something) package that contains a Python API for talking to a Review Board server, which rbtools (and post-review) will then use. For now, the goal is to just get post-review moved over. Reviewed at http://reviews.review-board.org/r/788/
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d809eaf
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+About rbtools
+=============
+
+rbtools is a collection of console utility scripts for use with Review Board.
+
+This consists of the following officially supported tools:
+
+ * post-review - Create and update review requests based on changes in
+ a local tree.
+
+
+There are also some user-contributed scripts and application plugins in the
+contrib directory. See the associated README files for more information.