From a231ffb8d5e49cff8401137b89233d4f51c7f802 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <m@maandree.se>
Date: Sun, 23 Feb 2025 21:02:09 +0100
Subject: change license, replace info with man, simplify makefile
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <m@maandree.se>
---
 README | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

(limited to 'README')

diff --git a/README b/README
index de8b231..66e1aa9 100644
--- a/README
+++ b/README
@@ -1 +1,49 @@
-Let your system generate a maintenance notification RSS
+NAME
+	sysrss - Let your system generate a maintenance notification RSS
+
+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 runs in the foreground, and should be daemonised externally
+	(unless you actually want it in the foreground).
+
+	sysrss runs as a user process, meaning that each user using it must
+	have their own instance started individually.
+
+OPTIONS
+	None.
+
+OPERANDS
+	None.
+
+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.
+
+		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
+		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 generated RSS news item. If the empty string is returned, no
+		news item is generated.
+
+	$HOME/.sysrss/log
+		Log file.
+
+	$HOME/.sysrss/maintenance.rss
+		RSS-feed to add to your RSS aggregator to get your notifications.
+
+	$HOME/.sysrss/tmp
+		Reserved temporary file.
+
+SEE ALSO
+	None.
-- 
cgit v1.2.3-70-g09d2