commit cd3ab7cb9ca689b003e9ca84d1f254f41c13f758
parent fe8fe2acb98ee90129ae1e90598780830b468150
Author: citbl <citbl@citbl.org>
Date: Wed, 8 Oct 2025 23:18:40 +1000
doco and fixes to build
Diffstat:
4 files changed, 38 insertions(+), 21 deletions(-)
diff --git a/docs/readr.1 b/docs/readr.1
@@ -39,9 +39,9 @@ Fill it with RSS feeds URLS, one per line, e.\&g.\&
.PP
.nf
.RS 4
-https://example\&.com/rss1
-https://example\&.com/rss2
-https://example\&.com/rss3
+https://example1\&.com/rss
+https://example2\&.com/rss
+https://example3\&.com/rss
.fi
.RE
.PP
diff --git a/docs/readr.html b/docs/readr.html
@@ -31,20 +31,24 @@
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<p class="Pp">readr - small RSS viewer in terminal</p>
+<p class="Pp">readr</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<p class="Pp">readr</p>
+<p class="Pp">Small RSS viewer in terminal</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">readr is a minimal RSS viewer for the terminal, it reads feeds
- sources from a file and displays the posts</p>
+ URLS from a file and displays the posts for quick viewing.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="OPTIONS"><a class="permalink" href="#OPTIONS">OPTIONS</a></h1>
-<p class="Pp">see config.h, overwrite at will and recompile.</p>
+<p class="Pp">See config.h, overwrite at will and recompile.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="INSTALLATION"><a class="permalink" href="#INSTALLATION">INSTALLATION</a></h1>
+<p class="Pp">make install</p>
</section>
<section class="Sh">
<h1 class="Sh" id="REQUIREMENTS"><a class="permalink" href="#REQUIREMENTS">REQUIREMENTS</a></h1>
@@ -52,26 +56,39 @@
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-<p class="Pp">create a file name ~/.config/readr/feeds</p>
-<p class="Pp">fill it with feeds, separated by a new line, e.g.</p>
-<p class="Pp">https://example.com/rss1 https://example.com/rss2
- https://example.com/rss3</p>
-<p class="Pp">launch readr</p>
-<p class="Pp">select feeds/posts, with arrows, and ENTER to open the post
- link.</p>
+<p class="Pp">Feeds are loaded from a config file; create a file
+ `~/.config/readr/feeds`</p>
+<p class="Pp">Fill it with RSS feeds URLS, one per line, e.g.</p>
+<p class="Pp"></p>
+<div class="Bd-indent">
+<pre>https://example1.com/rss
+https://example2.com/rss
+https://example3.com/rss</pre>
+</div>
+<p class="Pp">Note that currently we load feeds before the UI, so loading readr
+ will take O(n x loadtime)</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="KEY_BINDINGS"><a class="permalink" href="#KEY_BINDINGS">KEY
+ BINDINGS</a></h1>
+<ul class="Bl-bullet">
+ <li>Use <b>ARROWS</b> to select feeds / posts,</li>
+ <li>press <b>ENTER</b> to open the post's link,</li>
+ <li>press <b>SPACE</b> to open comments, if comments are available.</li>
+</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
-<p class="Pp">citbl</p>
+<p class="Pp">citbl, 2025</p>
</section>
<section class="Sh">
<h1 class="Sh" id="LICENSE"><a class="permalink" href="#LICENSE">LICENSE</a></h1>
-<p class="Pp">MIT</p>
+<p class="Pp">Apache-2.0</p>
</section>
</div>
<table class="foot">
<tr>
- <td class="foot-date">2025-10-05</td>
+ <td class="foot-date">2025-10-08</td>
<td class="foot-os"></td>
</tr>
</table>
diff --git a/docs/readr.scd b/docs/readr.scd
@@ -31,9 +31,9 @@ Feeds are loaded from a config file; create a file `~/.config/readr/feeds`
Fill it with RSS feeds URLS, one per line, e.g.
```
-https://example.com/rss1
-https://example.com/rss2
-https://example.com/rss3
+https://example1.com/rss
+https://example2.com/rss
+https://example3.com/rss
```
Note that currently we load feeds before the UI, so loading readr will take O(n x loadtime)
diff --git a/makefile b/makefile
@@ -12,7 +12,7 @@ clean:
release: clean
cc **.c ${CREL} ${PKG} -o ${APP}
-install: release manpage
+install: release
mkdir -p /usr/local/bin
install -m755 readr /usr/local/bin/.
mkdir -p /usr/local/share/man/man1
