Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
krick
committed
May 11, 2009
1 parent
91e50df
commit 9c13098
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
= Tea-time = | ||
|
||
Tea-time is an extention to emacs. | ||
Kind of analog of gnome applet tea-time http://det.cable.nu/teatime/index.rbx?r=2.8.0 | ||
|
||
It allows you to set up time intervals and after this | ||
interval is elapsed, Emacs will notify you with sound and notification. | ||
It could be useful if you make a tea or if you would like to | ||
be more productive by setting time limit for a task. | ||
|
||
If available, notification would be done with great tool | ||
mumbles ( http://www.mumbles-project.org ) | ||
If not, then simply use standard emacs message. | ||
|
||
= Requirements: = | ||
|
||
tested on Emacs 23, | ||
should work on any version. | ||
|
||
= Installation: = | ||
|
||
1. Download from http://github.com/krick/tea-time/tree/master, | ||
or simply <code>git clone git://github.com/krick/tea-time.git</code> | ||
|
||
2. Add tea-time directory to the load path, if needed | ||
<code>(add-to-list "path-to-tea-time"))</code> | ||
|
||
3. Add the code below in your .emacs | ||
<code>(require 'tea-time)</code> | ||
|
||
4. Customize variable <code>tea-time-sound</code> via <code>M-x customize</code> | ||
or simply put <code>(setq tea-time-sound "path-to-sound-file")</code> in .emacs | ||
|
||
= Usage: = | ||
|
||
* Interactively call (tea-time) | ||
|
||
* Enter period in minutes if you want to start timer | ||
* Or press Enter without giving any number - if you would like to know how much time is remaining before the timer expires | ||
|
||
* Use (tea-timer-cancel) to cancel currently running timer. | ||
|
||
* Suggested binding: | ||
(define-key global-map "\C-ct" 'tea-time) | ||
|
||
|
||
|