feed reader for terminal
Go to file
Grigory Kirillov 507c1dc7c8 add sort-by-important action (#98), rebind mark-important and mark-unimportant to f and F 2024-03-24 10:16:12 +03:00
doc add sort-by-important action (#98), rebind mark-important and mark-unimportant to f and F 2024-03-24 10:16:12 +03:00
src add sort-by-important action (#98), rebind mark-important and mark-unimportant to f and F 2024-03-24 10:16:12 +03:00
tests update setting lines syntax without a set keyword 2024-03-23 02:48:50 +03:00
.gitignore implement per-feed configuration (#82), add reload-period and item-limit settings 2024-03-16 22:49:27 +03:00
README.md reflect support for per-feed settings in docs 2024-03-17 03:00:37 +03:00
makefile speed up feed parsing by roughly 4% with gperf hashing and serialization optimizations 2024-02-03 01:13:32 +03:00

README.md

Description

Newsraft is a feed reader with ncurses user interface. It's greatly inspired by Newsboat and tries to be its lightweight counterpart.

Newsraft in action

Features

  • Parallel downloads
  • Section-based feeds grouping
  • Opening links in any program
  • Viewing news from all feeds with explore mode
  • Automatic updates for feeds and sections
  • Per-feed and per-section settings
  • Multiple actions key bindings
  • Support for feed generating scripts
  • Text search by news titles
  • Interactive interface for viewing news content

Check out comparison of Newsraft and Newsboat.

Dependencies

Name Version Necessity
curl >= 7.87.0 required
expat >= 2.4.8 required
gumbo-parser >= 0.11.0 required
ncursesw >= 6.2 required
sqlite >= 3.36.0 required
yajl >= 2.1.0 required
C compiler Any C99 required at build-time
make Any POSIX required at build-time
pkg-config >= 0.29.2 optional at build-time
gperf >= 3.1 only for development
scdoc >= 1.9.1 only for development

Installing

Some package repositories have Newsraft package so it can be installed with a package manager.

Packaging status

If your package repository doesn't provide Newsraft package, you can build it from source. Detailed instructions for different platforms are described in doc/build-instructions.md.

Learning more

The essential source of information about Newsraft is its man page (if you already have Newsraft installed, you can open it with the man newsraft command). Alternatively you can read the HTML version of this man page here.

Examples on how to configure Newsraft are located in the doc/examples directory.

Contributing

Reporting bugs: doc/contributing-report.md

Making changes: doc/contributing-change.md

Copying

Newsraft is distributed under the terms of the ISC license.