README

PopUpDoro - A Pomodoro Notifier

DESCRIPTION

This program uses libnotify to provide you with alerts for using the 
Pomodoro technique for time management.  The benefit of using this notifier 
system is that the alerts fit in nicely with the system, as they look like 
part of the OS.

The intent of this program was to create an unobtrusive notification system
for use with the Pomodoro Technique.  I was not satisfied with the solutions
I had seen, and when I found out about libnotify (through a post using it for
Pomodoro), I thought it to be what I was looking for.  A few improvements
later, I had something I actually wanted to use.

Again, I can't take credit for the original idea.  You can find the original 
script and the blog post it came from here:

http://blog.ashfame.com/2011/04/pomodoro-timer-in-ubuntu/

LICENSE

The code in this project is released under GPLv3. You can find a Copy of the GPL
in the file called COPYING.

Sound clips provided were created by John McEachin 
(http://www.youtube.com/user/jdmceach1), and are released under a Creative 
Commons Attribution-ShareAlike 3.0 Unported License.  You can find the terms of
this license at http://creativecommons.org/licenses/by-sa/3.0/ in a 
human-readable (non-legalspeak) form, or the full license terms in the media
folder in a file called LICENSE.

INSTRUCTIONS

To run this script, you need libnotify-bin and aplay installed on your
system. Simply running the following command will do install them:

	apt-get install libnotify-bin python-notify

Afterwards, to run the script itself, you run the command:

	python pomodoro.py

You can change settings (icon, times, number of pomodoros before long breaks,
etc) in the 'settings.py' file.

MORE INFORMATION
http://www.pomodorotechnique.com/