README
1==============
2Git Change Bar
3==============
4
5.. contents::
6
7
8About
9=====
10
11This plugin highlights uncommitted changes to files tracked with Git,
12allows to navigate through the hunks and undo them.
13
14
15Requirements
16============
17
18This plugin depends on libgit2, and obviously Geany (>= 1.25).
19
20
21Installation
22============
23
24For detailed instructions, see the INSTALL file of the Geany-Plugins package
25this plugin is part of.
26
27
28Usage
29=====
30
31When loaded into Geany, this plugins adds markers in the markers margin.
32If the marker margin is not visible, they are displayed as line backgrounds.
33
34When you point your mouse on a marker that indicates a changed or removed hunk,
35a tooltip pops up showing the original contents of that hunk.
36
37To navigate through the hunks of the current file, you need to configure the
38plugin's *Go to next hunk* and *Go to previous hunk* keybindings in Geany's
39preferences dialog.
40
41Hunks can also be undone by either setting a cursor at a line with a hunk and
42invoking the *Undo hunk at the cursor position* or by right-clicking in the
43editor where the hunk is located and selecting *Undo Git hunk* from the popup
44menu.
45
46License
47=======
48
49This plugin is distributed under the terms of the GNU General Public License
50as published by the Free Software Foundation, either version 3 of the
51License, or (at your option) any later version. You should have received a copy
52of the GNU General Public License along with Git Change Bar. If not, see
53<http://www.gnu.org/licenses/>.
54
55
56Contact
57=======
58
59You can email me at <ban(at)herbesfolles(dot)org>, and I may also be on the
60#geany channel on FreeNode, under the `b4n` nickname.
61
62
63Bug reports and feature requests
64--------------------------------
65
66To report a bug or ask for a new feature, please use the Geany-Plugins tracker
67on GitHub: https://github.com/geany/geany-plugins/issues
68