commit e3ee0360fae2062269fef097a0f37059e3a1b829
parent eed62b345ff3e15ba010a2fcedf55f93d9de2cb5
Author: citbl <citbl@citbl.org>
Date: Wed, 8 Oct 2025 23:15:35 +1000
doco
Diffstat:
2 files changed, 50 insertions(+), 23 deletions(-)
diff --git a/docs/readr.1 b/docs/readr.1
@@ -9,19 +9,23 @@
.PP
.SH NAME
.PP
-readr - small RSS viewer in terminal
+readr
.PP
.SH SYNOPSIS
.PP
-readr
+Small RSS viewer in terminal
.PP
.SH DESCRIPTION
.PP
-readr is a minimal RSS viewer for the terminal, it reads feeds sources from a file and displays the posts
+readr is a minimal RSS viewer for the terminal, it reads feeds URLS from a file and displays the posts for quick viewing.\&
.PP
.SH OPTIONS
.PP
-see config.\&h, overwrite at will and recompile.\&
+See config.\&h, overwrite at will and recompile.\&
+.PP
+.SH INSTALLATION
+.PP
+make install
.PP
.SH REQUIREMENTS
.PP
@@ -29,22 +33,35 @@ see config.\&h, overwrite at will and recompile.\&
.PP
.SH EXAMPLES
.PP
-create a file name ~/.\&config/readr/feeds
+Feeds are loaded from a config file; create a file `~/.\&config/readr/feeds`
+.PP
+Fill it with RSS feeds URLS, one per line, e.\&g.\&
.PP
-fill it with feeds, separated by a new line, e.\&g.\&
+.nf
+.RS 4
+https://example\&.com/rss1
+https://example\&.com/rss2
+https://example\&.com/rss3
+.fi
+.RE
.PP
-https://example.\&com/rss1
-https://example.\&com/rss2
-https://example.\&com/rss3
+Note that currently we load feeds before the UI, so loading readr will take O(n x loadtime)
.PP
-launch readr
+.SH KEY BINDINGS
.PP
-select feeds/posts, with arrows, and ENTER to open the post link.\&
+.PD 0
+.IP \(bu 4
+Use \fBARROWS\fR to select feeds / posts,
+.IP \(bu 4
+press \fBENTER\fR to open the post'\&s link,
+.IP \(bu 4
+press \fBSPACE\fR to open comments, if comments are available.\&
+.PD
.PP
.SH AUTHORS
.PP
-citbl
+citbl, 2025
.PP
.SH LICENSE
.PP
-MIT
+Apache-2.\&0
diff --git a/docs/readr.scd b/docs/readr.scd
@@ -2,19 +2,23 @@ READR(1)
# NAME
-readr - small RSS viewer in terminal
+readr
# SYNOPSIS
-readr
+Small RSS viewer in terminal
# DESCRIPTION
-readr is a minimal RSS viewer for the terminal, it reads feeds sources from a file and displays the posts
+readr is a minimal RSS viewer for the terminal, it reads feeds URLS from a file and displays the posts for quick viewing.
# OPTIONS
-see config.h, overwrite at will and recompile.
+See config.h, overwrite at will and recompile.
+
+# INSTALLATION
+
+make install
# REQUIREMENTS
@@ -22,22 +26,28 @@ see config.h, overwrite at will and recompile.
# EXAMPLES
-create a file name ~/.config/readr/feeds
+Feeds are loaded from a config file; create a file `~/.config/readr/feeds`
-fill it with feeds, separated by a new line, e.g.
+Fill it with RSS feeds URLS, one per line, e.g.
+```
https://example.com/rss1
https://example.com/rss2
https://example.com/rss3
+```
+
+Note that currently we load feeds before the UI, so loading readr will take O(n x loadtime)
-launch readr
+# KEY BINDINGS
-select feeds/posts, with arrows, and ENTER to open the post link.
+- Use *ARROWS* to select feeds / posts,
+- press *ENTER* to open the post's link,
+- press *SPACE* to open comments, if comments are available.
# AUTHORS
-citbl
+citbl, 2025
# LICENSE
-MIT
+Apache-2.0
