You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Batischev b462e935c3
Merge pull request #789 from dennisschagt/feature/test-fslock
2 days ago
.github Encourage issue reporters to post their configs 2 months ago
3rd-party Update Catch to 2.11.1 1 month ago
contrib reset daemon to 1 2 weeks ago
doc Merge pull request #785 from newsboat/feature/filter-regex-tests 3 days ago
docker Add Git to "build tools" Docker image 4 days ago
filter Implement new naming style 1 year ago
git-hooks Neutralize pre-commit hook for now 1 year ago
include Merge pull request #774 from newsboat/feature/convert-utf8-at-boundary 6 days ago
mk Revert change in sorting of mk.deps (caused by local g++) 3 days ago
po Update Dutch translation for download speed display 2 weeks ago
rss RssParser::__w3cdtf_to_rfc822 -> w3cdtf_to_rfc822 1 month ago
rust Explain why unwrap() and expect() won't panic 1 week ago
snap Replace Asciidoc with Asciidoctor in dependencies 2 weeks ago
src Merge pull request #774 from newsboat/feature/convert-utf8-at-boundary 6 days ago
stfl Rename `eot-tildes` to `end-of-text-marker` 2 weeks ago
test Mark lock_location as const 2 days ago
.astylerc Format the code with AStyle 4 months ago
.cirrus.yml Fix depslist check on Cirrus CI 4 days ago
.editorconfig Add editorconfig ( http://editorconfig.org/ ) 3 years ago
.gitattributes Drop .clang-format from .gitattributes as well 2 months ago
.gitignore Use proper file extension for Asciidoc 2 weeks ago
.rustfmt.toml Add rustfmt config 4 months ago
.travis.yml Move most Ubuntu Bionic builds from Travis to Cirrus CI 1 week ago
CHANGELOG.md Rename `eot-tildes` to `end-of-text-marker` 2 weeks ago
Cargo.lock Bump libc and openssl-sys crates 2 months ago
Cargo.toml Turn platform-specific strprintf crates into mods 6 months ago
LICENSE Update copyright year 2019->2020 1 month ago
Makefile Make Cargo aware of how many jobs Make can run 1 week ago
README.md Replace Asciidoc with Asciidoctor in dependencies 2 weeks ago
config.h Change NEWSBEUTER_PATH_SEP into a single char ('/') 1 month ago
config.sh config.sh: do not grep README for deps' URLs 7 months ago
logo.svg Re-draw logo from scratch, increase the hull size slightly 3 months ago
newsboat.cpp Display paths to config/urls/cache in --help 3 weeks ago
podboat.cpp Format the code with AStyle 4 months ago
submit-to-coveralls.sh Coveralls: always provide service-name and job-id, token optional 4 weeks ago
txt2h Use "NEWSBOAT" in include guards 2 years ago

README.md

Newsboat Travis CI Build Status Cirrus CI Build Status Coverage Status

<img

src="https://newsboat.org/logo.svg"
alt="Newsboat logo"
align="left"
height="60"
width="60"
vspace="6" /></a>

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:

  • xtr (can be installed with cargo install xtr)
  • Coco/R for C++, needed to re-generate
  • filter language parser using regenerate-parser target.

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

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.

Newsboat can also be built in Docker.

License

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