/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: Szilveszter Farkas (Phanatic)
  • Date: 2007-03-15 12:43:48 UTC
  • mto: (126.1.38 bzr-gtk)
  • mto: This revision was merged to the branch mainline in revision 172.
  • Revision ID: szilveszter.farkas@gmail.com-20070315124348-0nx0zb7fv4pa8xk6
Fix the indentation error in the TortoiseBZR test.

Show diffs side-by-side

added added

removed removed

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