From e48b81b9f0cb18a8cea687052dfca00deb39c947 Mon Sep 17 00:00:00 2001 From: Alexander Ruf Date: Tue, 1 Jan 2013 21:08:15 +0100 Subject: [PATCH] Added some installation instructions for Windows users. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ac1a565..e295d6d5 100644 --- a/README.md +++ b/README.md @@ -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* @@ -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: