Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 205 lines (165 sloc) 7.485 kb
934eb41 JD Isaacks Add read me
authored
1 ## Git Gutter
2
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
3 A sublime text 2/3 plugin to show an icon in the gutter area indicating whether a line has been inserted, modified or deleted.
934eb41 JD Isaacks Add read me
authored
4
5 ### Screenshot:
6
7 ![screenshot](https://raw.github.com/jisaacks/GitGutter/master/screenshot.png)
8
24d1162 JD Isaacks Add installation instructions to read me
authored
9 ### Installation
10
984839f JD Isaacks Update README.md
authored
11 You can install via [Sublime Package Control](http://wbond.net/sublime_packages/package_control):
12 * [GitGutter](https://sublime.wbond.net/packages/GitGutter) - Release based
13 * [GitGutter-Edge](https://sublime.wbond.net/packages/GitGutter-Edge) - Stick with master branch (at your own peril)
14
15 Or you can clone this repo into your *Sublime Text x/Packages*:
24d1162 JD Isaacks Add installation instructions to read me
authored
16
18aa206 Ben Evans Ubuntu Installation (via Git)
bencevans authored
17 *OSX*
24d1162 JD Isaacks Add installation instructions to read me
authored
18 ```shell
19 cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
a09d288 Timo Tijhof readme: Use anonymous git url for Ubuntu and Mac
Krinkle authored
20 git clone git://github.com/jisaacks/GitGutter.git
24d1162 JD Isaacks Add installation instructions to read me
authored
21 ```
22
18aa206 Ben Evans Ubuntu Installation (via Git)
bencevans authored
23 *Ubuntu*
24 ```shell
25 cd ~/.config/sublime-text-2/Packages
a09d288 Timo Tijhof readme: Use anonymous git url for Ubuntu and Mac
Krinkle authored
26 git clone git://github.com/jisaacks/GitGutter.git
18aa206 Ben Evans Ubuntu Installation (via Git)
bencevans authored
27 ```
28
e48b81b Alexander Ruf Added some installation instructions for Windows users.
alexruf authored
29 *Windows*
c1bb5c4 Alexander Ruf Fixed a markdown error
alexruf authored
30
9d9144b Alexey Lebedev Update the Windows section of the README
alisey authored
31 GitGutter assumes that the `git` command is available on the command line. If it's not, add the directory containing `git.exe` to your `PATH` environment variable. Then clone the repo:
e48b81b Alexander Ruf Added some installation instructions for Windows users.
alexruf authored
32
c1bb5c4 Alexander Ruf Fixed a markdown error
alexruf authored
33 ```dos
9d9144b Alexey Lebedev Update the Windows section of the README
alisey authored
34 cd "%APPDATA%\Sublime Text 2\Packages"
35 git clone git://github.com/jisaacks/GitGutter.git
e48b81b Alexander Ruf Added some installation instructions for Windows users.
alexruf authored
36 ```
37
aa58a91 Federico Brigante Suggest SublimeFixMacPath on OSX
bfred-it authored
38 On OS X you might need to install the package [SublimeFixMacPath](https://github.com/int3h/SublimeFixMacPath).
39
ce8bcab Tom Spencer Updated Readme to include compare against options
fiznool authored
40 ### Comparing against different commits/branches/tags
41
42 By default, Git Gutter compares your working copy against the HEAD. You can change this behaviour through the ST command palette. The following options are available:
43
44 - Compare against HEAD
45 - Compare against particular branch
46 - Compare against particular tag
47 - Compare against specific commit
48
49 To change the compare option:
50
51 - Open the command palette (`Ctrl-Shift-P` for Windows/Linux, `Cmd-Shift-P` for Mac)
52 - Start typing `GitGutter`
53 - You'll see the 4 options listed above, select one with the keyboard.
54 - Choose the branch/tag/commit to compare against.
55
934eb41 JD Isaacks Add read me
authored
56 ### Settings
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
57 Settings are accessed via the <kbd>Preferences</kbd> > <kbd>Package Settings</kbd> > <kbd>GitGutter</kbd> menu.
934eb41 JD Isaacks Add read me
authored
58
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
59 Default settings should not be modified, as they are overwritten when GitGutter updates. Instead, you should copy the relevant settings into GitGutter's user settings file.
934eb41 JD Isaacks Add read me
authored
60
530a63d JD Isaacks Add non_blocking to README settings
authored
61 #### Non Blocking Mode
62 By default, GitGutter runs in the same thread which can block if it starts to perform slowly. Usually this isn't a problem but depending on the size of your file or repo it can be. If you set `non_blocking` to `true` then GitGutter will run in a seperate thread and will not block. This does cause a slight delay between when you make a modification and when the icons update in the gutter. This is a ***Sublime Text 3 only feature***, ST2 users can turn off live mode if performance is an issue.
63
1a9509e JD Isaacks Update README.md
authored
64 #### Debounce Delay
65 When using non_blocking mode, delay update of gutter icons by the following amount (in milliseconds). Useful for performance issues. Default 1000 (1 second).
66
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
67 #### Live Mode
68 By default, GitGutter detects changes every time the file is modified. If you experience performance issues you can set it to only run on save by setting `live_mode` to `false`.
69
42f26f6 JD Isaacks Added info about untracked/ignored icons setting.
authored
70
71 #### Untracked Files
b34bfad JD Isaacks Make show icons for new/ignored files on by default
authored
72 GitGutter shows icons for new files and ignored files. These icons will be on everyline. You can toggle the setting `show_markers_on_untracked_file` to turn this feature off. Defaults to true (shows icons). You may need to add scopes to your color scheme (`markup.ignored.git_gutter` and `markup.untracked.git_gutter`) to color the icons.
42f26f6 JD Isaacks Added info about untracked/ignored icons setting.
authored
73
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
74 #### Git path
7eb18f9 Valentin Laube Typo in the settings documentation
vlaube-de authored
75 If git is not in your PATH, you may need to set the `git_binary` setting to the location of the git binary, e.g. in a portable environment;
5cb11fd Chris White Fixed code snippet syntax problem
christopherdwhite authored
76 ```json
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
77 {
7eb18f9 Valentin Laube Typo in the settings documentation
vlaube-de authored
78 "git_binary": "E:\\Portable\\git\\bin\\git.exe"
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
79 }
80 ```
81
32fb686 David L. Goldberg Updates readme for keymap info.
DavidLGoldberg authored
82
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
83 #### Per-project Settings
84 Sublime Text supports project-specific settings, allowing `live_mode` to be set differently for different repositories.
85 To implement, use the <kbd>Project</kbd> > <kbd>Edit Project</kbd> menu and add the `settings` key as shown.
934eb41 JD Isaacks Add read me
authored
86 ```json
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
87 {
88 "folders":
89 [
90 {
91 "path": "src"
92 }
93 ],
94 "settings":
95 {
96 "live_mode": false
97 }
98 }
934eb41 JD Isaacks Add read me
authored
99 ```
100
1c11f57 Frazer McLean Add details of new settings into README
RazerM authored
101 #### Icon Coloring
102
65e853b JD Isaacks Start a list of color schemes that define colors for git gutter
authored
103 The colors come from your *color scheme* **.tmTheme** file.
104
105 Color schemes that already have support for GitGutter include:
106
b3646a3 Neil Cresswell Condensed Both Dark Room Themes Into One URL
NeilCresswell authored
107 * [Dark Room](https://github.com/NeilCresswell/themes)
65e853b JD Isaacks Start a list of color schemes that define colors for git gutter
authored
108 * [Deep Blue See](https://github.com/jisaacks/DeepBlueSee)
dd642b0 JD Isaacks Update README.md
authored
109 * [Flatland](https://github.com/thinkpixellab/flatland)
65e853b JD Isaacks Start a list of color schemes that define colors for git gutter
authored
110 * [Monokai Extended](https://github.com/jisaacks/sublime-monokai-extended)
111 * [Perv](https://github.com/jisaacks/Perv-ColorScheme)
b88b61c Ben Brooks Add Tomorrow Theme to color scheme list
bbrks authored
112 * [Tomorrow Theme](https://github.com/chriskempson/tomorrow-theme)
d4b91dd JD Isaacks Update README.md
authored
113 * [Neon Color Scheme](https://github.com/MattDMo/Neon-color-scheme)
bea1f22 Channing Walton added underscore colour theme
channingwalton authored
114 * [Underscore Colour Theme](https://github.com/channingwalton/sublime_underscore)
c14b024 Add Solarize to list of colorschemes that support GitGutter
Vihang Mehta authored
115 * [Solarized Colour Theme](https://github.com/SublimeColors/Solarized)
81aef84 Joaquín Bernal Add Baara Dark to color schemes list
jobedom authored
116 * [Baara Dark](https://github.com/jobedom/sublime-baara-dark)
1923a9a Than Tibbetts adds Special Boards to list of supporting themes
than authored
117 * [Specials Board](https://github.com/lamotta/specialsboard)
2f39448 James Brooks Added Oblivion to color scheme list
jbrooksuk authored
118 * [Oblivion](https://github.com/jbrooksuk/Oblivion)
6db9ce4 Ken Collins Glacier Theme Supported
metaskills authored
119 * [Glacier](http://glaciertheme.com)
58e97e1 Stephen Kamenar Added my color scheme to the README list
farzher authored
120 * [Neon](https://github.com/farzher/Sublime-Text-Themes)
5311eae José María Clemente Added Afterglow theme.
YabataDesign authored
121 * [Afterglow](https://github.com/YabataDesign/afterglow-theme)
d37e764 Fernando L. Garcia Bermudez Add link to Desert Night Color Scheme
fgb authored
122 * [Desert Night](https://github.com/fgb/desert_night)
000f198 Wes Bos Added Cobalt2 as a supported colour scheme
wesbos authored
123 * [Cobalt2](https://github.com/wesbos/cobalt2)
9aedc4a Karel Vuong Add 'Fox' to list of colour schemes that support GitGutter
karelvuong authored
124 * [Fox](https://github.com/karelvuong/fox)
7b41ddf JD Isaacks Update README.md
authored
125 * _Contact me if you want your color scheme listed here. Or do a pull request._
65e853b JD Isaacks Start a list of color schemes that define colors for git gutter
authored
126
127 If your color scheme file does not define the appropriate colors (or you want to edit them) add an entry that looks like this:
934eb41 JD Isaacks Add read me
authored
128
129 ```xml
130 <dict>
131 <key>name</key>
977a24e Nikita K. Change style scope to 'gitgutter' to not override diffs coloring
Mendor authored
132 <string>GitGutter deleted</string>
934eb41 JD Isaacks Add read me
authored
133 <key>scope</key>
ff63644 Nikita K. Added '.git_gutter' tail to README and revert of previous commit.
Mendor authored
134 <string>markup.deleted.git_gutter</string>
934eb41 JD Isaacks Add read me
authored
135 <key>settings</key>
136 <dict>
137 <key>foreground</key>
138 <string>#F92672</string>
139 </dict>
140 </dict>
141 <dict>
142 <key>name</key>
977a24e Nikita K. Change style scope to 'gitgutter' to not override diffs coloring
Mendor authored
143 <string>GitGutter inserted</string>
934eb41 JD Isaacks Add read me
authored
144 <key>scope</key>
ff63644 Nikita K. Added '.git_gutter' tail to README and revert of previous commit.
Mendor authored
145 <string>markup.inserted.git_gutter</string>
934eb41 JD Isaacks Add read me
authored
146 <key>settings</key>
147 <dict>
148 <key>foreground</key>
149 <string>#A6E22E</string>
150 </dict>
151 </dict>
152 <dict>
153 <key>name</key>
977a24e Nikita K. Change style scope to 'gitgutter' to not override diffs coloring
Mendor authored
154 <string>GitGutter changed</string>
934eb41 JD Isaacks Add read me
authored
155 <key>scope</key>
ff63644 Nikita K. Added '.git_gutter' tail to README and revert of previous commit.
Mendor authored
156 <string>markup.changed.git_gutter</string>
934eb41 JD Isaacks Add read me
authored
157 <key>settings</key>
158 <dict>
159 <key>foreground</key>
160 <string>#967EFB</string>
161 </dict>
162 </dict>
b34bfad JD Isaacks Make show icons for new/ignored files on by default
authored
163 <dict>
164 <key>name</key>
165 <string>GitGutter ignored</string>
166 <key>scope</key>
167 <string>markup.ignored.git_gutter</string>
168 <key>settings</key>
169 <dict>
170 <key>foreground</key>
171 <string>#565656</string>
172 </dict>
173 </dict>
174 <dict>
175 <key>name</key>
176 <string>GitGutter untracked</string>
177 <key>scope</key>
178 <string>markup.untracked.git_gutter</string>
179 <key>settings</key>
180 <dict>
181 <key>foreground</key>
182 <string>#565656</string>
183 </dict>
184 </dict>
ff63644 Nikita K. Added '.git_gutter' tail to README and revert of previous commit.
Mendor authored
185 ```
7b45285 JD Isaacks Change README...
authored
186
92063d7 Gerard Roche :memo: keymaps table
gerardroche authored
187 ### Jumping Between Changes
4c3107e JD Isaacks Add alternatives section to README
authored
188
92063d7 Gerard Roche :memo: keymaps table
gerardroche authored
189 There are commands to jump between modifications. The default keybindings for these commands are:
4c3107e JD Isaacks Add alternatives section to README
authored
190
92063d7 Gerard Roche :memo: keymaps table
gerardroche authored
191 | OS X | Windows / Linux | Description |
192 |------|-----------------|-------------|
193 | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>k</kbd> | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>k</kbd> | Previous |
194 | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>j</kbd> | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>j</kbd> | Next |
4c3107e JD Isaacks Add alternatives section to README
authored
195
196 ### Alternatives
934eb41 JD Isaacks Add read me
authored
197
4c3107e JD Isaacks Add alternatives section to README
authored
198 *Don't use Sublime?*
199 - [Vim GitGutter](https://github.com/airblade/vim-gitgutter)
200 - [Emacs GitGutter](https://github.com/syohex/emacs-git-gutter)
934eb41 JD Isaacks Add read me
authored
201
4c3107e JD Isaacks Add alternatives section to README
authored
202 *Don't use Git?*
203 - [VcsGutter](https://github.com/bradsokol/VcsGutter)
204 - [Modific](https://github.com/gornostal/Modific) *Not a port/fork of __GitGutter__ but similar*
Something went wrong with that request. Please try again.