Skip to content

Commit 217ead4

Browse files
committed
Add some troubleshooting steps to readme
1 parent a49b1a5 commit 217ead4

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.markdown

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,29 @@ Package Control will automatically keep Git up to date with the latest version.
2727

2828
If you don't want to use Package Control, [check the wiki](https://github.com/kemayo/sublime-text-git/wiki) for other installation methods on various platforms.
2929

30+
## Troubleshooting
31+
32+
This package works by running commands as your system `git`. As such, if you have problems with this package, first make sure that git is installed and configured correctly on your system.
33+
34+
You may want to make sure that the `git` binary this plugin is using is the correct one, if you have multiple ones installed. Most git installation guides will be happy to walk you through configuring your system `$PATH` appropriately.
35+
36+
If necessary, set the `git_command` plugin preference to tell us where to look.
37+
38+
### `fatal: unable to auto-detect email address`
39+
40+
Git isn't configured properly. Tell it who you are, by opening a command prompt and doing this:
41+
42+
git config --global user.email "you@example.com"
43+
git config --global user.name "Your Name"
44+
45+
If you've done this and it's still complaining, you probably have multiple copies of git on your system which have different configuration locations, and the one which runs on your command line isn't the one which the shell `$PATH` exposes to Sublime Text.
46+
47+
### `fatal: could not read Username for 'https://github.com': Device not configured`
48+
49+
Git isn't configured to use a system-level ssh-agent, and so it's asking you for a username and password when you try to push / pull. The plugin doesn't know how to ask you for this information.
50+
51+
[Set up a ssh-agent](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#adding-your-ssh-key-to-the-ssh-agent) and this will stop happening.
52+
3053
## Acknowledgements
3154

3255
This package contains:

0 commit comments

Comments
 (0)