README.md (4161B)
1 # Zeitung
2
3 For comments and ideas, please send issues and code-patches to:
4 [jayvii+zeitung[AT]posteo[DOT]de](mailto:jayvii+zeitung[AT]posteo[DOT]de).
5
6 ## About
7
8 A thin script around [`perlanet`](https://github.com/davorg-cpan/perlanet) and
9 [`morss`](github.com/pictuga/morss) that gathers news from a pre-defined set of
10 sources and formats them for newspaper-style consumption in various formats,
11 such as:
12
13 - HTML, i.e. for any type of browser either mobile or desktop
14 - PDF, once in DIN A4 and once in DIN A 5 format with the
15 [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template) template
16 - EPUB for ebook readers
17
18 Zeitung is intended to run **once a day**, e.g. in the very early morning, so
19 you can get updated on the latest news once a day without falling in a habit to
20 check news constantly all day. Of course, the script also works if you would
21 like to update all document types multiple times a day, if you really wish to.
22
23 For example, you could generate the documents automatically every morning at 6AM
24 on your webserver and publish them through your already running webserver, from
25 where you can download the appropriate document to your device.
26
27 - Examplary use cases would be to read *Zeitung* in the morning on an E-Book
28 reader (EPUB) or tablet (EPUB or DIN A5 PDF).
29 - Or read *Zeitung* while commuting via train on a phone (HTML or DIN A5 PDF)
30 - Or maybe, for you the best time for news consumption is during the evening on
31 your computer screen (HTML or DIN A4 PDF)
32
33 Please be aware that the `generate.sh` script will strip out all articles that
34 were published before yesterday. Again, this is intended to be read daily, once
35 a day and be done with it.
36
37 General formatting, external content, graphics and advertisement is stripped
38 from the article view as much as possible.
39
40 ## Name
41
42 *Zeitung* means newspaper in German. Very original, I know.
43
44 
45
46 ## Screenshots
47
48 Here are some screenshot for outputs *Zeitung* can look like. The look is
49 subject to change and can be adapted freely. But the screenshots below will give
50 an impression of what *Zeitung* achieves and how it presents articles.
51
52 
53
54 
55
56 
57
58 
59
60 ## Dependencies
61
62 - [Pandoc](https://pandoc.org/)
63 - [LaTeX / TeX Live](https://www.tug.org/texlive/)
64 - [XeTeX](https://www.tug.org/xetex/)
65 - [Source Code Pro font](https://tug.org/FontCatalogue/sourcecodepro/)
66 - [Perlanet](https://github.com/davorg-cpan/perlanet/)
67
68 Optionally, install [morss](https://github.com/pictuga/morss) on your own server
69 or use a public service like the upstream [morss.it](https://morss.it).
70
71 ## How to start
72
73 Copy the example perlanet config `perlanetrc.example.yaml` to `perlanetrc.yaml`
74 and edit it accordingly. Please refer to the
75 [perlanet documentation](https://github.com/davorg-cpan/perlanet) for specifics.
76
77 For Zeitung to work properly, each feed needs both an article summary as well as
78 the full content of the article. Most news websites do not publish the full text
79 article within their RSS feeds. In these cases, you can use `morss` to fetch
80 the full text from the article sites for you (see `perlanetrc.example.yaml`).
81
82 Then, run the `generate.sh` script. The output documents will be stored in the
83 `output/` directory.
