commit cd09beed131b263ef034c4471abb23c4f903ada1
parent 80b0178fb50159eeabd51d70e1ac0ed2f2212715
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Mon, 2 Mar 2026 18:39:05 +0100
feat: further details on usage
Diffstat:
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -5,8 +5,8 @@ For comments and ideas, please send issues and code-patches to:
## About
-A thin script around `[perlanet](https://github.com/davorg-cpan/perlanet)` and
-`[morss](github.com/pictuga/morss)` that gathers news from a pre-defined set of
+A thin script around [`perlanet`](https://github.com/davorg-cpan/perlanet) and
+[`morss`](github.com/pictuga/morss) that gathers news from a pre-defined set of
sources and formats them for newspaper-style consumption in various formats,
such as:
@@ -30,6 +30,10 @@ where you can download the appropriate document to your device.
- Or maybe, for you the best time for news consumption is during the evening on
your computer screen (HTML or DIN A4 PDF)
+Please be aware that the `generate.sh` script will strip out all articles that
+were published before yesterday. Again, this is intended to be read daily, once
+a day and be done with it.
+
## Name
*Zeitung* means newspaper in German. Very original, I know.
@@ -55,3 +59,6 @@ For Zeitung to work properly, each feed needs both an article summary as well as
the full content of the article. Most news websites do not publish the full text
article within their RSS feeds. In these cases, you can use `morss` to fetch
the full text from the article sites for you (see `perlanetrc.example.yaml`).
+
+Then, run the `generate.sh` script. The output documents will be stored in the
+`output/` directory.
