Skip to content

Commit

Permalink
Add read me
Browse files Browse the repository at this point in the history
  • Loading branch information
jisaacks committed Dec 11, 2012
1 parent 661d542 commit 934eb41
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Git Gutter

A sublime text 2 plugin to show an icon in the gutter area indicating whether a line has been inserted, modified or deleted.

### Screenshot:

![screenshot](https://raw.github.com/jisaacks/GitGutter/master/screenshot.png)

### Settings

By default it is set to live mode, which runs everytime the file is modified. If you experience performance issues you can set it to only run on save by adding an entry to your **Preferences.sublime-text** file, just set:

```json
"git_gutter_live_mode": false
```

The colors come from your theme file. If your theme file does not define the appropriate colors (or you want to edit them) add an entry to your theme file that looks like this:

This comment has been minimized.

Copy link
@sentience

sentience Dec 13, 2012

The colors actually come from your color scheme (.tmTheme) file, not your theme (.sublime-theme) file. Suggest you correct this to avoid confusion.

This comment has been minimized.

Copy link
@jisaacks

jisaacks Dec 13, 2012

Author Owner

@sentience I updated the read me, thanks.


```xml
<dict>
<key>name</key>
<string>diff.deleted</string>
<key>scope</key>
<string>markup.deleted</string>
<key>settings</key>
<dict>
<key>foreground</key>
<string>#F92672</string>
</dict>
</dict>
<dict>
<key>name</key>
<string>diff.inserted</string>
<key>scope</key>
<string>markup.inserted</string>
<key>settings</key>
<dict>
<key>foreground</key>
<string>#A6E22E</string>
</dict>
</dict>
<dict>
<key>name</key>
<string>diff.changed</string>
<key>scope</key>
<string>markup.changed</string>
<key>settings</key>
<dict>
<key>foreground</key>
<string>#967EFB</string>
</dict>
</dict>
```


0 comments on commit 934eb41

Please sign in to comment.