/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
 
bzr-gtk - GTK+ Frontends to various Bazaar commands
2
 
===================================================
 
1
bzrk - visualisation plugin for bzr
 
2
===================================
3
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.
 
4
This is a plugin for bzr that allows you to see the history of a branch
 
5
and relationships between the revisions visually.
8
6
 
9
7
 
10
8
Dependencies
11
9
------------
12
10
 
13
 
bzr-gtk is written in Python, so doesn't need compiling, however you will
 
11
bzrk is written in Python, so doesn't need compiling, however you will
14
12
need the following runtime dependencies:
15
13
 
16
14
  * Python 2.4
17
 
  * bzr 0.11 or later
 
15
  * bzr 0.8 or later
18
16
  * PyGTK 2.8 or later
19
 
 
20
 
In order to see graphs in the visualisation tool, you will also need:
21
 
 
22
17
  * PyCairo 1.0 or later
23
18
 
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
19
 
36
20
Installation
37
21
------------
38
22
 
39
 
The easiest way to install bzr-gtk is to either copy or symlink the
 
23
The easiest way to install bzrk is to either copy or symlink the
40
24
directory into your ~/.bazaar/plugins directory.
41
25
 
42
26
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
 
27
your bzr working tree, or adding the location of bzrk to your
44
28
BZR_PLUGIN_PATH environment variable.
45
29
 
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
30
 
49
 
Usage - Visualisation
50
 
---------------------
 
31
Usage
 
32
-----
51
33
 
52
34
Simply run "bzr visualise" (or "bzr viz") while in a bzr working tree or
53
35
branch, a window will appear with the history of the branch and a graph
62
44
including the ids of the parent revisions.  Clicking on the go icon next
63
45
to a parent moves the list to that revision; clicking on the view icon
64
46
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.html (pycairo too)
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