====================
  gkrellm-reminder
====================


Table of Contents
=================
1. Requirements
2. Installation
3. Operation
4. Bugs
5. Thanks
6. Feedback


1. Requirements
=================
- GKrellM (2,0 or later) [http://gkrellm.net]
- GTK+ (2.0 or later) [http://www.gtk.org]


2. Installation
=================
See INSTALL for more information.


3. Operation
==============
The panel UI displays two numbers. The one on the left represents how many are
currently pending. Clicking on the numbers will display any pending events. The
number on the right indicates how many events occur today. Clicking on the
calendar will display all events that are scheduled for today. Right-clicking on
the panel will display the calendar.

The calendar is where events can be added, changed, and removed.

Adding an event:
a) Type in a name. This will be displayed when the event is scheduled.
b) Select how often you want the event to appear. Tip: Selecting daily and
   setting days to "1" will show the event everyday. Use this as the default
   setting.
c) Set the start and end date and time. Note: This is inclusive.
d) Click on "Add"
e) To reset the fields to their default states, click on "Default"

Removing an event:
a) Select the event in the list.
b) Click on "Remove"

Modifying an existing event:
a) Select the event in the list.
b) Modify any of the fields.
c) Click on "Update"

There are also settings for displaying the events, they should be self-
explanatory. If not, see the help tab.

When a reminder is scheduled to occur, the numeric display will be updated and
the calendar icon will flash. When an event window is open, you will be given
three options. Clicking on "Never" will delete the event from the calendar so
that it is never shown again. Entering a time and clicking on "Later" will
display the event again in the specified number of minutes. Clicking on
"Dismiss" will acknowledge the reminder and not display it again today.


4. Bugs
=========
This is beta code. There are bound to be some, please let me know of any that
you find.

Also, I'm not sure if this plugin will run on non-Intel/AMD or non-Linux/BSD
systems. Please let me know if you have any trouble with these systems.


5. Thanks
===========
Special thanks go to:
- Christoph Kaegi for helping with BSD support
- Hereward Cooper for making the Debian Packages
- Kevin Bryan for fixing the DST bug


6. Feedback
=============
Author: James Simonsen
e-mail: simonjam@ucs.orst.edu
URL:    http://www.engr.orst.edu/~simonsen/reminder/

I'm looking for some nice artwork to replace the pitiful calendar icon that I've
created. I'm looking for something similar to the mail icon that comes with
GKrellM, but that would be fitting for gkrellm-reminder. The icon should have a
static state and then have an animation that is displayed when there are pending
events. It should also have neutral colors so that it'll work with any skin.
The mail icon is 22x12 with 18 frames of animation. Use that as a basis. I don't
have anything to offer in exchange for this work, but you will get mentioned in
the credits. And I get final say in whether I include it or not.
