Skip to content

Commit

Permalink
Added some installation instructions for Windows users.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexruf committed Jan 1, 2013
1 parent 729cfde commit e48b81b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Expand Up @@ -8,7 +8,7 @@ A sublime text 2 plugin to show an icon in the gutter area indicating whether a

### Installation

You can install via [Sublime Package Control](http://wbond.net/sublime_packages/package_control)
You can install via [Sublime Package Control](http://wbond.net/sublime_packages/package_control)
Or you can clone this repo into your *Sublime Text 2/Packages*

*OSX*
Expand All @@ -23,6 +23,14 @@ cd ~/.config/sublime-text-2/Packages
git clone git@github.com:jisaacks/GitGutter.git
```

*Windows*
GitGutter assumes that the `git` and `diff` command is availible on the command line. Since the MSI installer for Git on Windows only adds the `cmd` directory of your Git installation to the `PATH` environment variable by default, GitGutter may not work out of the box. In this case you have to add the `bin` directory of your Git installation to the `PATH` environment variable.

For example:
```shell
%PATH%;C:\Program Files (x86)\Git\bin;C:\Program Files (x86)\Git\cmd
```

### 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:
Expand Down

0 comments on commit e48b81b

Please sign in to comment.