readr

Minimal Terminal RSS Reader
Log | Files | Refs | README | LICENSE

readr.scd (929B)

      1 READR(1)
      2 
      3 # NAME
      4 
      5 readr
      6 
      7 # SYNOPSIS
      8 
      9 Small RSS viewer in terminal
     10 
     11 # DESCRIPTION
     12 
     13 readr is a minimal RSS viewer for the terminal, it reads feeds URLS from a file and displays the posts for quick viewing.
     14 
     15 # OPTIONS
     16 
     17 See config.h, overwrite at will and recompile.
     18 
     19 # INSTALLATION
     20 
     21 make install
     22 
     23 # REQUIREMENTS
     24 
     25 *libcurl*(1), *libmrss*(1), *sqlite3*(1)
     26 
     27 # EXAMPLES
     28 
     29 Feeds are loaded from a config file; create a file `~/.config/readr/feeds`
     30 
     31 Fill it with RSS feeds URLS, one per line, e.g.
     32 
     33 ```
     34 https://example1.com/rss
     35 https://example2.com/rss
     36 https://example3.com/rss
     37 ```
     38 
     39 Note that we load feeds before the UI, so loading readr will take a couple of
     40 seconds as load feeds multi-threaded (shown with dots, 1 dot per feed).
     41 
     42 # KEY BINDINGS
     43 
     44 - Use *ARROWS* to select feeds / posts,
     45 - press *ENTER* to open the post's link,
     46 - press *SPACE* to open comments, if comments are available.
     47 
     48 # AUTHORS
     49 
     50 citbl, 2025
     51 
     52 # LICENSE
     53 
     54 Apache-2.0