Go to file
Grigory Kirillov eca0bb905f fix not taking into account the search query when marking all items read/unread (#77) 2024-01-09 15:34:22 +03:00
doc clarify that tab is ^I (Ctrl-I) 2024-01-07 21:20:55 +03:00
src fix not taking into account the search query when marking all items read/unread (#77) 2024-01-09 15:34:22 +03:00
tests fix render_data test to match new render_block API 2023-12-25 09:55:22 +03:00
.gitignore store final man page in repo to remove scdoc build-time dependency, now it's just dev-time dependency (have to run scdoc only after man page recipe is actually changed) 2023-09-25 14:08:02 +03:00
README.md improve comparison with Newsboat 2023-12-31 22:52:53 +03:00
makefile make install targets more portable (#65) 2023-10-03 15:04:22 +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
  • 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
scdoc >= 1.9.1 only for rebuilding man page

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.