aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-02-22 14:37:25 +0100
committerMattias Andrée <m@maandree.se>2026-02-22 14:37:25 +0100
commitdeb939689ef825687d09bf93600d465f4e6e98ab (patch)
tree1650ef24eeb19c83119ee43e8d96481c89614b64 /README
parentchange license, replace info with man, simplify makefile (diff)
downloadsysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.gz
sysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.bz2
sysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.xz
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 8 insertions, 7 deletions
diff --git a/README b/README
index 66e1aa9..2d71c90 100644
--- a/README
+++ b/README
@@ -5,9 +5,10 @@ SYNOPSIS
sysrss
DESCRIPTION
- sysrss lets the user setup routines, written in Python 3, that run
- periodically to generate entires in an RSS feed that the use can
- syndicate to in his RSS aggregator (e-mail client can usually do this).
+ sysrss lets the user set up routines, written in Python 3, that run
+ periodically to generate entries in an RSS feed that the user can
+ syndicate to in his RSS aggregator (an e-mail client can usually
+ do this).
sysrss runs in the foreground, and should be daemonised externally
(unless you actually want it in the foreground).
@@ -24,15 +25,15 @@ OPERANDS
FILES
$HOME/.sysrss/sites
Created when the program is started for the first time by the
- user. It contains the tasks that shall be ran periodically.
- It's a Python 3.
+ user. It contains the tasks that shall be run periodically.
+ It is a Python 3 file.
To add a task, write a function that doesn't have any parameters
but returns a string, then run self.sites.append(Site(title,
- interval, function)), where title is the that the generated RSS
+ interval, function)), where title is what the generated RSS
news item should have, interval is the number of minutes between
each run of the job, and function is the name of your function.
- The string returned by the your function shall be the message of
+ The string returned by your function shall be the message of
the generated RSS news item. If the empty string is returned, no
news item is generated.