From 5de37f98bb89cd67901c76a34ad084bb4e35b0b0 Mon Sep 17 00:00:00 2001
From: Bruno Sutic <bruno.sutic@gmail.com>
Date: Mon, 10 Aug 2015 20:18:32 +0200
Subject: [PATCH] Add troubleshooting docs

---
 CHANGELOG.md            |  1 +
 README.md               |  2 ++
 docs/tpm_not_working.md | 28 ++++++++++++++++++++++++++++
 3 files changed, 31 insertions(+)
 create mode 100644 docs/tpm_not_working.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d141843..5f16917 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
 - upgrade to new version of `tmux-test`
 - bug: when using `emacs` copy mode, Enter does not quit screen after tpm
   installation/update. Fix by making `Escape` the key for emacs mode.
+- add a doc with troubleshooting instructions
 
 ### v3.0.0, 2015-08-03
 - refactor `shared_set_tpm_path_constant` function
diff --git a/README.md b/README.md
index 9559d83..1493e4a 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,8 @@ For more plugins, check [here](https://github.com/tmux-plugins).
 
 ### Docs
 
+- [Help, tpm not working](docs/tpm_not_working.md) - problem solutions
+
 More advanced features and instructions, regular users probably do not need
 this:
 
diff --git a/docs/tpm_not_working.md b/docs/tpm_not_working.md
new file mode 100644
index 0000000..95e3ba7
--- /dev/null
+++ b/docs/tpm_not_working.md
@@ -0,0 +1,28 @@
+# Help, tpm not working!
+
+Here's the list of issues users had with `tpm`:
+
+> Nothing works. `tpm` key bindings `prefix + I`, `prefix + U` not even
+  defined.
+
+[Issue #22](https://github.com/tmux-plugins/tpm/issues/22)
+
+- Do you have required `tmux` version to run `tpm`?<br/>
+  Check `tmux` version with `$ tmux -V` command and make sure it's higher or
+  equal to the required version for `tpm` as stated in the readme.
+
+- ZSH tmux plugin might be causing issues.<br/>
+  If you have it installed, try disabling it and see if `tpm` works then.
+
+> Weird sequence of characters show up when installing or updating plugins
+
+[Issue #25](https://github.com/tmux-plugins/tpm/issues/25)
+
+- This could be caused by [tmuxline.vim](https://github.com/edkolev/tmuxline.vim)
+  plugin. Uninstall it and see if things work.
+
+> "failed to connect to server" error when sourcing .tmux.conf
+
+[Issue #48](https://github.com/tmux-plugins/tpm/issues/48)
+
+- Make sure `tmux source ~/.tmux.conf` command is ran from inside `tmux`.