Skip to content
master
Switch branches/tags
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Jan 12, 2021

README.md

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.

Logo by noobilanderi, licensed under CC BY 4.0.

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 git://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
    
  • 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.