Use signed tags for releases
[email-reminder.git] / README
blob2cc2eb5b881c3d2a6f16d7f7b50651a1091dfee9
1 Email-Reminder
2 --------------
4 Email-reminder allows users to define events that they want to be
5 reminded of by email.  Possible events include birthdays,
6 anniversaries and yearly events.  Reminders can be sent on the day of
7 the event and a few days beforehand.
9 This package includes the cron job that checks for events and send
10 reminders once a day, and a simple GUI allowing users to edit the
11 reminders they want to receive.
14 Installation
15 ------------
17 See the INSTALL file.
20 Usage
21 -----
23 To add new reminders, use the "email-reminder-editor" program.
24 Reminders are automatically saved when the program is closed.
26 Use the "Test configuration" option in the "File" menu to force the
27 "send-reminders" script to run immediately.
29 Don't forget to set your name and email address under "Preferences" in
30 the "Edit" menu.
33 Sample files
34 ------------
36 Sample configuration files are included in the examples directory.
38 "email-reminder.conf" is a sample configuration file for the
39 "send-reminders" program whereas "email-reminders" is a sample user
40 reminder list.
43 License
44 -------
46 Copyright (C) 2004-2014 by Francois Marier (francois@fmarier.org)
48 Email-Reminder is free software; you can redistribute it and/or modify
49 it under the terms of the GNU General Public License as published by
50 the Free Software Foundation; either version 3 of the License, or (at
51 your option) any later version.
53 Email-Reminder is distributed in the hope that it will be useful, but
54 WITHOUT ANY WARRANTY; without even the implied warranty of
55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
56 General Public License for more details.
58 See the COPYING file for a copy of the GNU General Public License.