https://github.com/dtinth/pmd
My own simple Pomodoro timer, for Mac.
https://github.com/dtinth/pmd
cocoa ruby
Last synced: 6 months ago
JSON representation
My own simple Pomodoro timer, for Mac.
- Host: GitHub
- URL: https://github.com/dtinth/pmd
- Owner: dtinth
- Created: 2012-06-29T08:53:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-10-10T04:56:03.000Z (over 11 years ago)
- Last Synced: 2025-04-09T06:11:31.549Z (9 months ago)
- Topics: cocoa, ruby
- Language: Ruby
- Homepage:
- Size: 188 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Deprecated
==========
Check out the [Thyme](http://thymerb.com/) project by @hughbien with my [Mac OS X Status Bar Integration](https://github.com/dtinth/thyme_osx_ui) instead.
pmd
====
My simple Pomodoro timer for Mac OS X, command line based.
This new version does not require MacRuby anymore, but instead relies on the awesome [__cocoa__](https://github.com/patrickhno/cocoa) gem (see the [pull request](https://github.com/dtinth/pmd/pull/1)).
For the older MacRuby version, please see the [archive_macruby](https://github.com/dtinth/pmd/tree/archive_macruby) branch.
Installation
------------
Please install:
* `gem install cocoa` or `bundle install`
* Growl and growlnotify
Then clone this repository and add this to your `~/.bash_profile`:
alias pmd=/path/to/your/pmd/pmd
Usage
-----
Run:
pmd start
You will see a countdown timer at the top right corner of your screen. When it count to zero, you will see a Growl notification.
Configure Growl to make it emit sound.
Hooks
-----
`pmd` will also run these scripts, if they exist:
| Filename | Event |
| -------- | ----- |
| `~/.pmd/hooks/start` | When a Pomodoro is started. |
| `~/.pmd/hooks/finish` | When a Pomodoro is finished. |
| `~/.pmd/hooks/void` | When a Pomodoro is void. |
Checking the Remaining Time
---------------------------
Other scripts can check the remaining time by connecting to UNIX domain socket `/tmp/pomodoro.sock`.
For example,
nc -U /tmp/pomodoro.sock