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 f18894c2c7
Merge pull request #1196 from newsboat/feature/const-matchable
10 hours ago
.github Disable Dependabot for Docker 2 months ago
3rd-party Update Catch to 2.13.1 5 days ago
contrib contrib: change feedgrabber.rb cachedir from newsbeuter to newsboat 4 weeks ago
doc Bump MSRV to 1.44.0 2 days ago
docker Bump Rust to 1.46.0 on CI 3 weeks ago
filter Implement new naming style 1 year ago
git-hooks Neutralize pre-commit hook for now 2 years ago
include Use const reference instead of raw pointer 12 hours ago
mk ColorManager: Make ::set_pb_colors() more generic 2 weeks ago
po Merge pull request #1192 from der-lyse/update-german-translations 3 days ago
rss Integrate Miniflux into existing implementation 1 month ago
rust Release 2.21 2 days ago
snap Snap: Specify 'g++' build dependency 1 month ago
src Use const reference instead of raw pointer 12 hours ago
stfl FeedListFormAction: Stop using stfl's "pos_name" feature 1 month ago
test Mark Matchable::attribute_value() const 1 day ago
.astylerc Format the code with AStyle 11 months ago
.cirrus.yml Bump MSRV to 1.44.0 2 days ago
.editorconfig Add editorconfig ( http://editorconfig.org/ ) 3 years ago
.gitattributes Include Dockerfiles into release tarballs 2 months ago
.gitignore Removed some dead references. 2 months ago
.rustfmt.toml Add rustfmt config 11 months ago
.travis.yml Travis: use Clang 11 for the code coverage build 3 weeks ago
CHANGELOG.md Prepare CHANGELOG for the next release 2 days ago
Cargo.lock Update Cargo.lock to all latest versions 2 days ago
Cargo.toml Add Rust bindings for regex.h 5 months ago
LICENSE Update copyright year 2019->2020 8 months ago
Makefile Make rust library depend on Cargo.lock 1 month ago
README.md Bump MSRV to 1.44.0 2 days ago
config.h Change NEWSBEUTER_PATH_SEP into a single char ('/') 8 months ago
config.sh config.sh: do not grep README for deps' URLs 1 year ago
logo.svg Re-draw logo from scratch, increase the hull size slightly 10 months ago
newsboat.cpp Mention expected-lite in --help 3 months ago
podboat.cpp Fix segfault in podboat --help 5 days ago
submit-to-coveralls.sh Coveralls: pass it PR number 4 months ago
txt2h Use "NEWSBOAT" in include guards 2 years ago

README.md

Newsboat Travis CI Build Status Cirrus CI Build 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.)

    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.

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.