************************************************************************
*                                                                      *
*   EventCalendarScreenlet        Copyright (c) 2009 Martin Zuther     *
*                                                                      *
*   This program comes with ABSOLUTELY NO WARRANTY.  This is free      *
*   software, and you are welcome to redistribute it under certain     *
*   conditions.  Please read the file "LICENSE" for details.           *
*                                                                      *
************************************************************************


                             Introduction
                             ============

This is a Screenlet which displays calendar events -- such as
birthdays or public holidays -- using the Linux command-line tool
"pal".


                             Requirements
                             ============

You'll need the following applications (earlier or later versions may work just as well, but this is my setup):

* screenlets 0.1.2  (http://www.screenlets.org/)
* Python 2.5  (http://www.python.org/)
* pal 0.4.3  (http://palcal.sourceforge.net/)


                             Installation
                             ============

Before you start, make sure that "screenlets" works as expected.
Create a configuration file for "pal" and try running "pal" with it
from the console.  Please see its man page for further instructions.

To install the screenlet, do the following:

* download the screenlet file "EventCalendarScreenlet-x.xx.tar.gz"
* open the Screenlets Manager
* click on "Install"
* select "Install Screenlet" and click on "OK"
* navigate to the downloaded screenlet file, select it and click
  on "Open"
* select "EventCalendar" in Screenlets Manager and click on
  "Launch/Add"

That's it!  You might also want to use the "transparent" theme, as it
looks much nicer than the default one.  But it might not run on all
desktops, so I chose not to make it the standard theme...


                               Problems
                               ========

To resize the Screenlet, change to the current theme's directory (for
example "~/.screenlets/EventCalendar/themes/default"), open the file
"theme.conf" with your favourite editor, change the settings for
height and width, respectively, and restart the Screenlet.

If you encounter any other problems, open the console, change to the
installation directory (usually "~/.screenlets/EventCalendar") and try
running "./EventDatabase.py".  It will give you some debug information
that might help you locating the problem.


                               Contact
                               =======

I love to hear from people who use my applications.  So if you can
spare the time, have any suggestions, want to translate this Screenlet
to your language or create a nice theme, head over to my website
http://www.mzuther.de/ and drop me an email!

And now -- thanks for using free software.  I hope you'll enjoy it!
