1 files changed, 60 insertions, 0 deletions
diff --git a/kalarm/README b/kalarm/README
new file mode 100644
index 000000000..e52cf40b2
--- /dev/null
+++ b/kalarm/README
@@ -0,0 +1,60 @@
+KAlarm
+
+KAlarm is a personal alarm message, command and email scheduler. It lets you
+set up personal alarm messages which pop up on the screen at the chosen time,
+or you can schedule commands to be executed or emails to be sent.
+
+When setting up or modifying an alarm, the options available let you:
+ * choose whether the alarm should display a text message, display a text file,
+   execute a command, or send an email.
+ * configure the alarm to recur on an hours/minutes, daily, weekly, monthly or
+   annual basis, or set it to trigger every time you log in.
+ * specify that a reminder should be displayed in advance of the main alarm
+   time(s).
+ * choose a colour and font for displaying the alarm message.
+ * specify an audible beep or a sound file to play when the message is
+   displayed.
+ * choose whether or not the alarm should be cancelled if it can't be triggered
+   at its scheduled time. An alarm can only be triggered while you are logged
+   in and running a graphical environment. If you choose not to cancel the
+   alarm if it can't be triggered at the correct time, it will be triggered
+   when you eventually log in.
+
+In addition to its graphical mode, alarms may also be scheduled from the
+command line, or via DCOP calls from other programs.
+
+See the INSTALL file for installation instructions.
+
+
+USE ON NON-KDE DESKTOPS
+
+For details on the requirements for setting up KAlarm to run on non-KDE
+desktops, see the INSTALL file.
+
+
+PROGRAM STATUS
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.
+
+See the COPYING file for more details.
+
+
+BUGS:
+
+Bugs can be reported to the KDE bug tracking system (http://bugs.kde.org).
+There you can also get information about the status of older bugs.
+KAlarm, as most other KDE programs, offers a menu item "Report Bug" in the
+Help menu for convenient reporting of bugs or feature requests.
+
+
+COMMENTS AND SUGGESTIONS:
+
+Please send your comments and suggestions to
+David Jarvie <[email protected]>.