/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: 2007-07-15 15:05:06 UTC
  • Revision ID: jelmer@samba.org-20070715150506-1uemecr5kt7d4kvg
Fix whitespace, add comment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
bzrk - visualisation plugin for bzr
2
 
===================================
 
1
bzr-gtk - GTK+ Frontends to various Bazaar commands
 
2
===================================================
3
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.
 
4
This is a plugin for bzr that contains various GTK+ frontends to 
 
5
Bazaar commands. It currently contains a tool to see the history
 
6
and relationships between the revisions visually and one to 
 
7
view annotated files.
6
8
 
7
9
 
8
10
Dependencies
9
11
------------
10
12
 
11
 
bzrk is written in Python, so doesn't need compiling, however you will
 
13
bzr-gtk is written in Python, so doesn't need compiling, however you will
12
14
need the following runtime dependencies:
13
15
 
14
16
  * Python 2.4
15
 
  * bzr 0.1 or later
 
17
  * Bazaar with the same major version as bzr-gtk
16
18
  * PyGTK 2.8 or later
 
19
 
 
20
In order to see graphs in the visualisation tool, you will also need:
 
21
 
17
22
  * PyCairo 1.0 or later
18
23
 
 
24
In order to see syntax highlighted diffs:
 
25
 
 
26
  * gtksourceview python bindings (on Debian and Ubuntu systems, these
 
27
    are in the python-gnome2-desktop package)
 
28
 
 
29
In order to use the nautilus integration, you will need:
 
30
 
 
31
 * python-nautilus
 
32
 
 
33
For Olive on Windows:
 
34
 
 
35
 * pyWin32 (tested with build 209)
19
36
 
20
37
Installation
21
38
------------
22
39
 
23
 
The easiest way to install bzrk is to either copy or symlink the
 
40
The easiest way to install bzr-gtk is to either copy or symlink the
24
41
directory into your ~/.bazaar/plugins directory.
25
42
 
26
43
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
 
44
your bzr working tree, or adding the location of bzr-gtk to your
28
45
BZR_PLUGIN_PATH environment variable.
29
46
 
30
 
 
31
 
Usage
32
 
-----
33
 
 
34
 
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree,
35
 
a window will appear with the history of the branch and a graph
 
47
Note: the plugin directory of bzr-gtk must be called 'gtk'.
 
48
 
 
49
To use the nautilus integration, either place the nautilus-bzr.py file in
 
50
~/.nautilus/python-extensions or in /usr/lib/nautilus/extensions-1.0/python
 
51
 
 
52
Usage - Visualisation
 
53
---------------------
 
54
 
 
55
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
 
56
branch, a window will appear with the history of the branch and a graph
36
57
connecting the individual revisions.
37
58
 
38
 
Clicking on a revision in the list at the top will show its details in
39
 
pane at the bottom, clicking on any revision id will move the list at
40
 
the top to that revision.
 
59
You can move through the revision history by clicking or with the arrow
 
60
keys.  You can also use the Back (shortcut '[') and Forward (shortcut ']')
 
61
buttons which move to the previous and next revision from that selected
 
62
(which may not be immediately adjacent in the list).
 
63
 
 
64
Details for the selected revision are shown in the pane at the bottom,
 
65
including the ids of the parent revisions.  Clicking on the go icon next
 
66
to a parent moves the list to that revision; clicking on the view icon
 
67
opens a window to display the difference between the two revisions.
 
68
 
 
69
Usage - annotate
 
70
----------------
 
71
 
 
72
Simply run "bzr gannotate FILENAME" while in a bzr working tree or branch.
 
73
 
 
74
The commit log message is shown in the lower window pane for the selected
 
75
line.  The line number column is searchable; jump to a specific line by typing
 
76
the line number while the annotation pane is in focus. Control-f will also
 
77
initiate a search.
 
78
 
 
79
By default, lines are highlighted according to age. This functionality is a
 
80
crib of emacs' VC-annotate highlighting, and thus works similarly: blue is
 
81
oldest and red is youngest, and an assortment of other colors in-between:
 
82
 
 
83
        blue --> green --> yellow --> orange --> red
 
84
 
 
85
Time spans are scaled; for instance by selecting "1 Day", lines older than a
 
86
day will be highlighted blue, but changes in the past hour will be red and
 
87
lines 2 hours old may be orange. Highlighting can be turned off with --plain
 
88
if overwhelming.
 
89
 
 
90
Install on Windows
 
91
------------------
 
92
 
 
93
You can download the dependencies from the following locations:
 
94
 
 
95
 - Python: http://www.python.org/download/releases/2.4.3/
 
96
 - GTK: http://gladewin32.sourceforge.net/
 
97
 - PyGTK: http://www.mapr.ucl.ac.be/~gustin/win32_ports (pygtk, pygobject and pycairo)
 
98
 - Bazaar: http://bazaar-vcs.org/WindowsDownloads (Python-based should be okay)
 
99
 - pyWin32: http://sourceforge.net/project/showfiles.php?group_id=78018
 
100
 
 
101
As an Administrator, you can install Olive with the standard command:
 
102
 
 
103
 > c:\Python24\python.exe setup.py install
 
104
 
 
105
You can run Olive with this command:
 
106
 
 
107
 > c:\Python24\python.exe c:\Python\Scripts\olive-gtk
 
108
 
 
109