From a6f03a085ad9e0e5a81abdbd871366b1cbd483e9 Mon Sep 17 00:00:00 2001 From: Alan Hamlett Date: Sat, 22 Apr 2017 13:58:32 -0700 Subject: [PATCH] troubleshooting section in readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 683fd16..bacc5e7 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,28 @@ To use a custom python binary: The default is to use `python` from your system PATH. -WakaTime plugins share a common config file `~/.wakatime.cfg` located in your user home directory with [these options](https://github.com/wakatime/wakatime#configuring) available. +WakaTime plugins share a common config file `~/.wakatime.cfg` located in your user home directory with [these options][wakatime-cli-config] available. + + +Troubleshooting +--------------- + +Run `:WakaTimeDebugEnable` in Vim to see errors output in your status bar. +Enabling Debug Mode also writes verbose logs to `$WAKATIME_HOME/.wakatime.log` from [wakatime-cli][wakatime-cli]. +With Debug Mode enabled, the plugin sends data synchronously so disable it when finished debugging. + +The [How to Debug Plugins][how to debug] guide shows how to check when coding activity was last received from Vim use the [User Agents API][user agents api]. +For more general troubleshooting info, see the [wakatime-cli Troubleshooting Section][wakatime-cli-help]. + Uninstalling ------------ Remove `Bundle 'wakatime/vim-wakatime'` from your `.vimrc` file, then delete your `~/.wakatime.cfg` config file. + + +[wakatime-cli]: https://github.com/wakatime/wakatime +[wakatime-cli-config]: https://github.com/wakatime/wakatime#configuring +[wakatime-cli-help]: https://github.com/wakatime/wakatime#troubleshooting +[how to debug]: https://wakatime.com/faq#debug-plugins +[user agents api]: https://wakatime.com/developers#user_agents