sublime-wakatime/README.md

44 lines
1.6 KiB
Markdown
Raw Normal View History

sublime-wakatime
2013-07-02 09:43:12 +04:00
================
2015-09-26 21:51:19 +03:00
Sublime Text 2 & 3 plugin to quantify your coding using https://wakatime.com/.
2013-07-02 13:21:13 +04:00
Installation
------------
Heads Up! For Sublime Text 2 on Windows & Linux, WakaTime depends on [Python](http://www.python.org/getit/) being installed to work correctly.
2014-11-06 12:47:42 +03:00
2015-01-07 01:07:55 +03:00
1. Install [Package Control](https://packagecontrol.io/installation).
2013-07-02 13:21:13 +04:00
2015-01-07 01:07:55 +03:00
2. Using [Package Control](https://packagecontrol.io/docs/usage):
2013-07-02 13:21:13 +04:00
2014-11-06 12:47:42 +03:00
a) Inside Sublime, press `ctrl+shift+p`(Windows, Linux) or `cmd+shift+p`(OS X).
2013-07-02 13:21:13 +04:00
2013-07-11 07:24:39 +04:00
b) Type `install`, then press `enter` with `Package Control: Install Package` selected.
2013-07-11 07:24:39 +04:00
c) Type `wakatime`, then press `enter` with the `WakaTime` plugin selected.
2013-07-11 06:04:46 +04:00
2015-04-10 05:08:29 +03:00
3. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.
2013-07-02 13:21:13 +04:00
2014-11-06 12:47:42 +03:00
4. Use Sublime and your time will be tracked for you automatically.
2013-07-02 13:21:13 +04:00
2014-11-06 12:47:42 +03:00
5. Visit https://wakatime.com/dashboard to see your logged time.
2013-07-11 07:53:28 +04:00
2013-07-02 13:21:13 +04:00
Screen Shots
------------
2014-11-06 12:48:52 +03:00
![Project Overview](https://wakatime.com/static/img/ScreenShots/ScreenShot-2014-10-29.png)
2013-07-02 13:21:13 +04:00
2015-07-15 23:44:07 +03:00
Troubleshooting
---------------
First, turn on debug mode in your `WakaTime.sublime-settings` file.
![sublime user settings](https://wakatime.com/static/img/ScreenShots/sublime-wakatime-settings-menu.png)
Add the line: `"debug": true`
Then, open your Sublime Console with `View -> Show Console` to see the plugin executing the wakatime cli process when sending a heartbeat. Also, tail your `$HOME/.wakatime.log` file to debug wakatime cli problems.
For more general troubleshooting information, see [wakatime/wakatime#troubleshooting](https://github.com/wakatime/wakatime#troubleshooting).