👋 你好!goread 是一个适用于终端的 RSS/Atom 订阅阅读器。它允许你对订阅源进行分类并关注,并直接在命令行中阅读文章!它配备了一个由 bubble tea 制作的漂亮 TUI。功能包括:
- 订阅源分类
- 下载文章以供后续使用
- 离线模式
- 可自定义的配色方案
- OPML 文件支持
- 简洁美观的 TUI
❤️ 开始使用
使用 go install
安装
你可以使用 go
内置包管理器安装 goread
$ go install github.com/TypicalAM/goread@latest
使用 homebrew
安装
如果你使用 Homebrew,可以通过以下命令安装 goread:
$ brew install goread
从 AUR 安装
$ yay -S goread
$ yay -S goread-bin # 发布二进制文件
📸 它长什么样?
这里有一个基本用法的 gif:
你可以使用 pywal
的配色方案来创建 goread 配色方案!
⚙️ 配置
📝 urls 文件
urls 文件包含你订阅的类别和订阅源!该文件由程序在配置目录(通常是 ~/.config/goread/urls.yml
)中生成,看起来类似这样:
categories:
- name: News
desc: 来自世界各地的新闻
subscriptions:
- name: BBC
desc: BBC 的新闻
url: http://feeds.bbci.co.uk/news/rss.xml
- name: Tech
desc: 科技新闻
subscriptions:
- name: Wired
desc: Wired 团队的新闻
url: https://www.wired.com/feed/rss
- name: Chris Titus Tech (virtualization)
desc: Chris Titus Tech 关于虚拟化的内容
url: https://christitus.com/categories/virtualization/index.xml
你可以编辑这个文件来自动更改应用程序的内容(记住你也可以在 TUI 中编辑条目!)。
🌃 配色方案文件
配色方案文件包含你的应用程序的配色方案!它可以手动生成或使用 --dump_colors
标志生成。配色方案文件通常位于 ~/.config/goread/colorscheme.json
- 以下是它的样子!
{
"bg_dark": "#161622",
"bg_darker": "#11111a",
"text": "#FFFFFF",
"text_dark": "#47485b",
"color1": "#c29fec",
"color2": "#ddbec0",
"color3": "#89b4fa",
"color4": "#e06c75",
"color5": "#98c379",
"color6": "#fab387",
"color7": "#f1c1e4"
}
你可以使用 --get_colors
标志从 pywal 生成配色方案。为此,你需要提供 pywal 的 colors.json
文件,该文件通常位于 ~/.cache/wal/colors.json
。要生成 colors.json
文件,你可以运行 wal -stni ~/wallpapers/example.png
。
✨ 贡献
如果你有想法或某些功能不正常,随时创建一个 issue。如果是 bug,请记得:
- 使用
go install github.com/TypicalAM/goread@latest
或homebrew upgrade
更新 - 包含
goread --version
的输出 - 包含日志,通常位于 Linux 的
/tmp/goread.log
和 Windows 的%TMP%\goread.log
运行测试时(例如打包时),你可以通过将环境变量 TEST_OFFLINE_ONLY
设置为真值(例如 "YES")来禁用在线测试。
💁 致谢
库
演示使用 vhs 制作,这是一个很棒的工具,你绝对应该看看。其他使用的库包括:
字体和图标
logo 使用的字体是由 "Philatype" 设计的 sen-regular,根据开放字体许可证授权。图标由 throwaway icons 设计。
=======
许可证
版权所有 (C) 2023 Adam Piaseczny
本程序是自由软件:你可以根据自由软件基金会发布的 GNU 通用公共许可证的条款重新分发或修改它,可以选择使用第 3 版许可证,或(由你选择)任何更新的版本。
发布本程序是希望它能有用,但不提供任何保证;甚至没有对适销性或特定用途适用性的暗示保证。详情请参阅 GNU 通用公共许可证。
你应该已经收到了一份 GNU 通用公共许可证的副本。如果没有,请参阅 https://www.gnu.org/licenses/。