https://github.com/reesmichael1/roman
A CLI RSS reader. Mirror of https://git.sr.ht/~reesmichael1/roman
https://github.com/reesmichael1/roman
rss-reader
Last synced: about 1 year ago
JSON representation
A CLI RSS reader. Mirror of https://git.sr.ht/~reesmichael1/roman
- Host: GitHub
- URL: https://github.com/reesmichael1/roman
- Owner: reesmichael1
- License: gpl-3.0
- Created: 2019-09-02T03:28:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-06T23:39:34.000Z (almost 4 years ago)
- Last Synced: 2025-03-26T17:46:54.221Z (over 1 year ago)
- Topics: rss-reader
- Language: Nim
- Size: 143 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roman
A simple CLI RSS/Atom feed reader.
## Installation
`roman` is written in [Nim](https://nim-lang.org). Binaries are not yet available, so you will need to build from source. With `nim 0.20` installed, you should simply need to run `nimble build`.
## Usage
To subscribe to feeds, use the `subscribe` command. For example,
```
roman subscribe https://feedwebsite.com/feed.rss
```
`roman` will do its best to detect if the feed you've given is an RSS or an Atom feed. If `roman` is unable to tell if your feed is an RSS or an Atom feed (or if it guesses incorrectly), this command will not work. If this is the case, use the `--type` option:
```
roman subscribe https://feedwebsite.com/feed.rss --type rss
```
Then, when you run `roman`, you will be able to select a feed and post to view. Unread posts are marked as `[*]`.
When reading a post, you can (by default) press `L` to construct a list of all of the links in the post you are viewing as well as the link to the original post. After selecting one, the link will be opened in your default browser.
You can manage your subscriptions by running `roman manage`.
`roman` is still in very early development. [Several improvements are planned!](https://todo.sr.ht/~reesmichael1/roman) However, `roman` is already quite usable.
### Renderers
By default, `roman` uses [`html2text`](http://alir3z4.github.io/html2text/) to display post bodies. You will need to have it installed on your system.
However, if `roman` is compiled with `-d:internalRenderer`, the experimental [`nim-html2text`](https://git.sr.ht/~reesmichael1/nim-html2text) library will be used instead. This library still needs work, but it removes the need for an external dependency.
## Configuration
You will need to copy the `config/config` file in this repository to `roman/config` within your platform's standard config directory. You can change the values in the file to your taste.
## Platforms
Cross-platform support is fully intended, but for now, `roman` is only tested on Linux. (Most of the code should work just fine, but some filepaths that are generated are currently Linux-only. A patch would be happily accepted!)
## Contributing
Contributions are welcome! Please send patches, questions, requests, etc. to my [public inbox](mailto:~reesmichael1/public-inbox@lists.sr.ht).
Bug reports and feature requests may also be filed at the [project ticket tracker](https://todo.sr.ht/~reesmichael1/roman).