kkdd / newsboat

An RSS/Atom feed reader for text terminals

Newsboat

Newsboat is a fork of Newsbeuter, an RSS/Atom feed reader for the text console. The only difference is that Newsboat is actively maintained while Newsbeuter isn't.

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.

• GCC 4.9 or newer, or Clang 3.6 or newer
• Stable Rust (1.25.0 or newer)
• STFL (version 0.21 or newer)
• SQLite3 (version 3.5 or newer)
• libcurl (version 7.21.6 or newer)
• GNU gettext (on systems that don't provide gettext in the libc): ftp://ftp.gnu.org/gnu/gettext/
• pkg-config
• libxml2, xmllint, and xsltproc
• json-c (version 0.11 or newer)
• asciidoc
• DocBook XML
• DocBook XSL

Installation

First, you'll have to get the dependencies. Make sure to install the header files for the libraries (on Debian and derivatives, headers are in -dev packages, e.g. libsqlite3-dev.) After that, compiling and installing newsboat is as simple as:

$ make
$ sudo make install

And if you ever need to uninstall it, use make uninstall.

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

Support

• Check out our documentation and FAQ
• Bugs and whatnot should be reported to the issue tracker
• Drop us a line at newsboat mailing list
• Chat with developers and fellow users on #newsboat at Freenode (webchat available!)

Development

Decided to work on an issue, fix a bug or add a feature? Great! Be sure to check out our style guide.

You'll probably want to run the tests; here's how:

$ make -j5 PROFILE=1 all test  # 5 is CPU cores + 1, to parallelize the build
$ (cd test && TMPDIR=/dev/shm ./test --order rand) && cargo test

Note the use of ramdisk as TMPDIR: some tests create temporary files, which slows them down if TMPDIR is on HDD or even SSD.

We check the formatting of the Rust code during CI using rust-fmt. To make sure your code is properly formated install and run rust-fmt:

$ rustup component add rustfmt
$ cargo fmt

License

Newsboat is licensed under the MIT license; see the LICENSE file.