feed reader for terminal
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.
 
 
Grigory Kirillov 7199167814 sprinkle some formatting to the man page 1 week ago
doc sprinkle some formatting to the man page 1 week ago
examples make the config example even cooler 3 weeks ago
src call get_local_offset_relative_to_utc after database file optimization started 1 week ago
.gitignore move the build system from meson to make, get rid of gcc dependency, remove references to gcc and meson in licenses, add simple .gitignore 4 months ago
README.md relicense to ISC because it is shorter than MIT 4 weeks ago
makefile set version to 0.12 2 weeks ago

README.md

Description

Newsraft is a feed reader with ncurses user interface. It is greatly inspired by Newsboat and tries to be its lightweight counterpart. The design differences betwen these projects are mentioned in the doc/project-goals.md.

Dependencies

Name Version Necessity
ncursesw >= 6.2 required
sqlite >= 3.36.0 required
curl >= 7.80.0 required
expat >= 2.4.8 required
yajl >= 2.1.0 required
gumbo >= 0.10.1 required
C compiler Any C99 required at build-time
make Any POSIX required at build-time
scdoc >= 1.9.1 optional at build-time

Building

Compile:

make

Install (run as root):

make install

Learning more

The essential source of information about Newsraft is its man page. If you've built Newsraft from source with scdoc dependency, the man page should've been generated in the project directory. Alternatively you can try to read doc/newsraft.scd scdoc file which is used to generate the man page.

Examples on how to configure Newsraft are located in the examples directory.

Contributing

Reporting bugs: doc/contributing-report.md

Making changes: doc/contributing-change.md

Copying

Newsraft is distributed under the terms of the ISC license.