/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to README

  • Committer: Jelmer Vernooij
  • Date: 2006-05-19 16:37:13 UTC
  • Revision ID: jelmer@samba.org-20060519163713-be77b31c72cbc7e8
Move visualisation code to a separate directory, preparing for bundling 
the GTK+ plugins for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
bzrk - visualisation plugin for bzr
 
2
===================================
 
3
 
 
4
This is a plugin for bzr that allows you to see the history of a branch
 
5
and relationships between the revisions visually.
 
6
 
 
7
 
 
8
Dependencies
 
9
------------
 
10
 
 
11
bzrk is written in Python, so doesn't need compiling, however you will
 
12
need the following runtime dependencies:
 
13
 
 
14
  * Python 2.4
 
15
  * bzr 0.8 or later
 
16
  * PyGTK 2.8 or later
 
17
  * PyCairo 1.0 or later
 
18
 
 
19
 
 
20
Installation
 
21
------------
 
22
 
 
23
The easiest way to install bzrk is to either copy or symlink the
 
24
directory into your ~/.bazaar/plugins directory.
 
25
 
 
26
Other ways include doing the same in the bzrlib/plugins directory of
 
27
your bzr working tree, or adding the location of bzrk to your
 
28
BZR_PLUGIN_PATH environment variable.
 
29
 
 
30
 
 
31
Usage
 
32
-----
 
33
 
 
34
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
 
35
branch, a window will appear with the history of the branch and a graph
 
36
connecting the individual revisions.
 
37
 
 
38
You can move through the revision history by clicking or with the arrow
 
39
keys.  You can also use the Back (shortcut '[') and Forward (shortcut ']')
 
40
buttons which move to the previous and next revision from that selected
 
41
(which may not be immediately adjacent in the list).
 
42
 
 
43
Details for the selected revision are shown in the pane at the bottom,
 
44
including the ids of the parent revisions.  Clicking on the go icon next
 
45
to a parent moves the list to that revision; clicking on the view icon
 
46
opens a window to display the difference between the two revisions.