mirror of
https://github.com/nkanaev/yarr.git
synced 2025-05-24 00:33:14 +00:00
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# yarr
|
|
|
|
**yarr** (yet another rss reader) is a web-based feed aggregator which can be used both
|
|
as a desktop application and a personal self-hosted server.
|
|
|
|
The app is a single binary with an embedded database (SQLite).
|
|
|
|
|
|
|
|
## usage
|
|
|
|
The latest prebuilt binaries for Linux/MacOS/Windows AMD64 are available
|
|
[here](https://github.com/nkanaev/yarr/releases/latest). Installation instructions:
|
|
|
|
* MacOS
|
|
|
|
Download `yarr-*-macos64.zip`, unzip it, place `yarr.app` in `/Applications` folder, [open the app][macos-open], click the anchor menu bar icon, select "Open".
|
|
|
|
* Windows
|
|
|
|
Download `yarr-*-windows64.zip`, unzip it, open `yarr.exe`, click the anchor system tray icon, select "Open".
|
|
|
|
* Linux
|
|
|
|
Download `yarr-*-linux64.zip`, unzip it, place `yarr` in `$HOME/.local/bin`
|
|
and run [the script](etc/install-linux.sh).
|
|
|
|
[macos-open]: https://support.apple.com/en-gb/guide/mac-help/mh40616/mac
|
|
|
|
For self-hosting, see `yarr -h` for auth, tls & server configuration flags.
|
|
|
|
See more:
|
|
|
|
* [Building from source code](doc/build.md)
|
|
* [Fever API support](doc/fever.md)
|
|
|
|
## credits
|
|
|
|
[Feather](http://feathericons.com/) for icons.
|