diff --git a/README.rst b/README.rst index e09d9c1..7573925 100644 --- a/README.rst +++ b/README.rst @@ -46,3 +46,29 @@ Installation Each `plugin `_ should install wakatime for you, except for the `Emacs WakaTime plugin `_. If your plugin does not install wakatime cli(this package), install it with:: pip install wakatime + + +Troubleshooting +--------------- + +WakaTime CLI writes errors to a common log file in your User $HOME directory: + +``$HOME/.wakatime.log`` + +Set ``debug=true`` in ``~/.wakatime.cfg`` for more verbose logging, but don't forget to set it back to ``debug=false`` afterwards or your editor might be laggy while waiting for wakatime cli to finish executing. + +Each plugin also has it's own log file for things outside of the common wakatime cli: + +* **Atom** writes errors to the developer console (View -> Developer -> Toggle Developer Tools) +* **Brackets** errors go to the developer console (Debug -> Show Developer Tools) +* **Eclipse** logs can be found in the Eclipse ``Error Log`` (Window -> Show View -> Error Log) +* **Emacs** messages go to the *messages* buffer window +* **Jetbrains IDEs (IntelliJ IDEA, PyCharm, RubyMine, PhpStorm, AppCode, AndroidStudio, WebStorm)** log to ``idea.log`` (`locating IDE log files `_) +* **Komodo** logs are written to ``pystderr.log`` (Help -> Troubleshooting -> View Log File) +* **Netbeans** logs to it's own log file (View -> IDE Log) +* **Notepad++** errors go to ``notepadpp-wakatime.log`` in your User home directory (this file is only created when an error occurs) +* **Sublime** Text logs to the Sublime Console (View -> Show Console) +* **TextMate** logs to stderr so run TextMate from Terminal to see any errors (`enable logging `_) +* **Vim** errors get displayed in the status line or inline (use ``:redraw!`` to clear inline errors) +* **Visual Studio** errors go to ActivityLog.xml (`more info... `_) +* **Xcode** errors go to ``dmesg`` (type ``dmesg`` in a Terminal to view them)