/newsboat

An RSS/Atom feed reader for text terminals

Primary LanguageC++MIT LicenseMIT

Newsboat Cirrus CI Build Status GitHub Actions: Coveralls status Coverage Status CII Best Practices

Newsboat logo

Newsboat is an RSS/Atom feed reader for the text console. It's an actively maintained fork of Newsbeuter.

A feed reader pulls updates directly from sites like blogs and news agencies, and lets you review them in a single interface. Many times, the feed includes the full text of the update, so you don't even need to start a web browser! You can learn more about feed readers on Wikipedia.

Viewing an article in Newsboat

Notable features

Downloading

You can download the latest version of Newsboat from the official site: https://newsboat.org/

Alternatively, you can check out the latest version from the Git repository:

$ git clone https://github.com/newsboat/newsboat.git

Dependencies

Newsboat depends on a number of libraries, which need to be installed before Newsboat can be compiled.

Developers will also need:

Installation

There are numerous ways:

  • install from your distribution's repository (a lot of distros have a package);

  • install via Snap:

    $ sudo snap install newsboat
    

    Our snap only supports xdg-open as the browser, and you can't run arbitrary scripts for rendering and bookmarking. The reason is strict confinement; if we disabled it, the snap would be no better than a distribution's package;

  • build from source with Docker. Note that the resulting binary might not run outside of that same Docker container if your system doesn't have all the necessary libraries, or if their versions are too old;

  • build from source in a chroot: to avoid polluting your system with developer packages, or to avoid upgrading, you might use a tool like debootstrap to create an isolated environment. Once that's done, just build from source as outlined in the next item;

  • build from source.

    Install everything that's listed in the "Dependencies" section above. Make sure to install the header files as well (on Debian and derivatives, headers are in -dev packages, e.g. libsqlite3-dev.)

    Cross-compilers need to set CARGO_BUILD_TARGET; see cargo documentation.

    Then compile and install with:

    $ make                   #  pass -jN to use N CPU cores, e.g. -j8
    $ sudo make install      #  install everything under /usr/local
    

    To install to a different directory, pass prefix like so: sudo make prefix=/opt/newsboat install.

    To uninstall, run sudo make uninstall.

Support

Contributing

See CONTRIBUTING.md

License

Newsboat is licensed under the MIT license; see the LICENSE file. Logo by noobilanderi, licensed under CC BY 4.0.