diff --git a/README.md b/README.md new file mode 100644 index 0000000..dcccb95 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# FeedTheMonkey + +FeedTheMonkey is a desktop client for [Tiny Tiny RSS](https://tt-rss.org). It doesn't +work as a standalone feed reader — it connects to a TT-RSS server via the Fever/Greader +API to fetch articles and sync read state. + +This is version 3, rewritten in Rust with GTK4 and libadwaita. + +## Dependencies + +### Runtime + +- GTK 4 (`gtk4`) +- libadwaita (`libadwaita`) +- WebKitGTK 6 (`webkitgtk-6.0`) +- GLib / GIO (`glib-2.0`, `gio-2.0`) + +On Arch Linux: `sudo pacman -S gtk4 libadwaita webkitgtk-6.0` + +### Build + +- Rust toolchain (`rustup` / `cargo`) +- `blueprint-compiler` — compiles `.blp` UI files to `.ui` +- `glib-compile-schemas` — compiles GSettings schemas (part of `glib2`) +- `glib-compile-resources` — compiles GResource bundles (part of `glib2`) + +On Arch Linux: `sudo pacman -S blueprint-compiler glib2` + +## Building + +```sh +cargo build --release +``` + +The binary is at `target/release/feedthemonkey`. + +## Installing + +```sh +sudo ./install.sh +``` + +This installs the binary, icon, desktop entry, and GSettings schema to `/usr/local`. +Set `PREFIX` to install elsewhere: + +```sh +sudo PREFIX=/usr ./install.sh +``` + +## Keyboard shortcuts + +| Key | Action | +|-----|--------| +| `j` or `→` | Next article | +| `k` or `←` | Previous article | +| `Return` | Open in browser | +| `r` | Reload | +| `F11` | Toggle fullscreen | +| `Ctrl+W` | Quit | +| `Ctrl++` | Zoom in | +| `Ctrl+-` | Zoom out | +| `Ctrl+0` | Reset zoom | + +## License + +Copyright 2015–2026 Jeena + +FeedTheMonkey is free software: you can redistribute it and/or modify it under the terms +of the GNU General Public License as published by the Free Software Foundation, either +version 3 of the License, or (at your option) any later version.