{"id":26692952,"url":"https://github.com/reesmichael1/roman","last_synced_at":"2025-04-12T23:41:25.529Z","repository":{"id":148627259,"uuid":"205770246","full_name":"reesmichael1/roman","owner":"reesmichael1","description":"A CLI RSS reader. Mirror of https://git.sr.ht/~reesmichael1/roman","archived":false,"fork":false,"pushed_at":"2022-09-06T23:39:34.000Z","size":146,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T17:46:54.221Z","etag":null,"topics":["rss-reader"],"latest_commit_sha":null,"homepage":null,"language":"Nim","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reesmichael1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-02T03:28:58.000Z","updated_at":"2022-09-06T23:39:39.000Z","dependencies_parsed_at":"2023-05-20T18:00:10.481Z","dependency_job_id":null,"html_url":"https://github.com/reesmichael1/roman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reesmichael1%2Froman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reesmichael1%2Froman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reesmichael1%2Froman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reesmichael1%2Froman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reesmichael1","download_url":"https://codeload.github.com/reesmichael1/roman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647254,"owners_count":21139081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rss-reader"],"created_at":"2025-03-26T17:38:30.810Z","updated_at":"2025-04-12T23:41:25.523Z","avatar_url":"https://github.com/reesmichael1.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Roman\n\nA simple CLI RSS/Atom feed reader.\n\n## Installation\n\n`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`. \n\n## Usage\n\nTo subscribe to feeds, use the `subscribe` command. For example, \n\n```\nroman subscribe https://feedwebsite.com/feed.rss\n```\n\n`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:\n\n```\nroman subscribe https://feedwebsite.com/feed.rss --type rss\n```\n\nThen, when you run `roman`, you will be able to select a feed and post to view. Unread posts are marked as `[*]`. \n\nWhen 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.\n\nYou can manage your subscriptions by running `roman manage`.\n\n`roman` is still in very early development. [Several improvements are planned!](https://todo.sr.ht/~reesmichael1/roman) However, `roman` is already quite usable.\n\n### Renderers\n\nBy default, `roman` uses [`html2text`](http://alir3z4.github.io/html2text/) to display post bodies. You will need to have it installed on your system. \n\nHowever, 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.\n\n## Configuration\n\nYou 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. \n\n## Platforms\n\nCross-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!)\n\n## Contributing\n\nContributions are welcome! Please send patches, questions, requests, etc. to my [public inbox](mailto:~reesmichael1/public-inbox@lists.sr.ht).\n\nBug reports and feature requests may also be filed at the [project ticket tracker](https://todo.sr.ht/~reesmichael1/roman).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freesmichael1%2Froman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freesmichael1%2Froman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freesmichael1%2Froman/lists"}