- C 98.7%
- Makefile 1.3%
| doc | add support for multiple actions in one binding, remove mark-read-and-jump-to-next, mark-read-and-jump-to-next-unread and mark-unread-and-jump-to-next actions, document multiple actions in one binding in man page, rise _XOPEN_SOURCE to 700 | |
| examples | add note about optionality of config file | |
| src | simplify get_input_command calls | |
| .gitignore | ignore callgrind.out files | |
| makefile | add support for multiple actions in one binding, remove mark-read-and-jump-to-next, mark-read-and-jump-to-next-unread and mark-unread-and-jump-to-next actions, document multiple actions in one binding in man page, rise _XOPEN_SOURCE to 700 | |
| README.md | improve words | |
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 between these projects are mentioned in the doc/project-goals.md.
Dependencies
| Name | Version | Necessity |
|---|---|---|
| curl | >= 7.87.0 | required |
| expat | >= 2.4.8 | required |
| gumbo | >= 0.10.1 | required |
| ncursesw | >= 6.2 | required |
| sqlite | >= 3.36.0 | required |
| yajl | >= 2.1.0 | required |
| C compiler | Any C99 | required at build-time |
| make | Any POSIX | required at build-time |
| pkg-config | >= 0.29.2 | optional at build-time |
| scdoc | >= 1.9.1 | optional at build-time |
Installing
Some package repositories have Newsraft package so it can be installed with a package manager.
If your package repository doesn't provide Newsraft package, you can build it from source. Detailed instructions for different platforms are described in doc/build-instructions.md.
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 the recipe for generating this 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.