From d0d977ff561fa8939fda21cbd0707ac45a458a48 Mon Sep 17 00:00:00 2001 From: Felitendo Date: Thu, 24 Sep 2026 02:00:33 +0200 Subject: [PATCH] docs: cut the readme down, fold the details --- README.md | 141 +++++++++++++++++++++++++++--------------------------- 1 file changed, 71 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 131c077..4e83d0a 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@

middleclick-autoscroll

-

Middle-click autoscroll in every application that supports it.

+

Middle-click autoscroll in every app that supports it.

- Works with browsers, electron apps like discord and spotify, steam, and anything else that runs on chromium. + Browsers, Electron apps like Discord and Spotify, Steam and anything else built on Chromium.

+ Install | How to use | - Install | Report a bug
@@ -20,34 +20,19 @@ Buy Me A Coffee

-This tool looks at which of your apps run chromium under the hood and applies the necessary steps to get autoscrolling working (often just a feature flag). One install, one command and autoscroll _✨just works✨_ (like on windows). +## Install -## How to use - -Just run `middleclick-autoscroll`. This will open the configuration TUI that looks like this: - -

- The middleclick-autoscroll menu in Konsole: autoscroll on, 19 of 19 applications covered -

- -Normally you just need to press `[1]` and the magic is done. -Pressing `[3]` lets you see every app that was found and toggle each one individually. - -

- The applications list in Konsole, each with how it gets autoscroll -

- -You can also press `[4]` for more settings. - -## How to install - -**Arch** +
+Arch ```bash yay -S middleclick-autoscroll ``` -**Fedora** +
+ +
+Fedora ```bash sudo curl -fsSL -o /etc/yum.repos.d/middleclick-autoscroll.repo \ @@ -55,7 +40,10 @@ sudo curl -fsSL -o /etc/yum.repos.d/middleclick-autoscroll.repo \ sudo dnf install middleclick-autoscroll ``` -**Bazzite** +
+ +
+Bazzite ```bash sudo curl -fsSL -o /etc/yum.repos.d/middleclick-autoscroll.repo \ @@ -64,7 +52,10 @@ sudo rpm-ostree install middleclick-autoscroll systemctl reboot ``` -**Debian** +
+ +
+Debian, Ubuntu ```bash sudo install -d -m 0755 /etc/apt/keyrings @@ -75,7 +66,10 @@ echo "deb [signed-by=/etc/apt/keyrings/middleclick-autoscroll.gpg] https://looni sudo apt update && sudo apt install middleclick-autoscroll ``` -**openSUSE** +
+ +
+openSUSE ```bash sudo rpm --import https://loonixtools.github.io/middleclick-autoscroll/KEY.gpg @@ -84,64 +78,71 @@ sudo zypper addrepo --gpgcheck --refresh \ sudo zypper install middleclick-autoscroll ``` -## How it works +
-Blink (the engine in Chromium, Electron, and CEF) already has autoscroll, but -it's off on Linux by default because middle click normally pastes the clipboard (??). -This flag turns it on: +## How to use +```bash +middleclick-autoscroll +``` + +

+ The middleclick-autoscroll menu in Konsole: autoscroll on, 19 of 19 applications covered +

+ +Press **1**. Autoscroll _✨just works✨_, like on Windows. + +
+Applications + +**3** lists every app it found. Space turns one on or off. + +

+ The applications list in Konsole, each with how it gets autoscroll +

+ +
+ +## More + +
+How it works + +Chromium, Electron and CEF all have autoscroll built in, but it is off on Linux. One flag turns it on: + +``` --enable-blink-features=MiddleClickAutoscroll +``` -But doing that for every app is kinda bothersome and it also might break with updates. -That's why I created this small tool to automate that. +Setting that for every app by hand is a pain and breaks with updates, so this tool does it for you. +New apps are picked up on their own. AppImages are covered too, without unpacking or starting them. -Browsers get the same thing but this time without "blink": +
---enable-features=MiddleClickAutoscroll +
+Commands -But both do the same ¯\_(ツ)_/¯ - -Except in Helium and Brave, which have their own names for it -(`HeliumMiddleClickAutoscroll`, and Brave's is actually spelled -`MiddelButtonClickAutoscroll`), so browsers get those as well. - -New apps are picked up by a systemd path unit that watches the -relevant directories. If you hate systemd; `middleclick-autoscroll apply` does the -same thing manually. - -AppImages get looked into as well. The payload is a squashfs image glued onto -the runtime, and squashfs keeps a small table with the name of every file in -there. So that table gets read and unpacked (a few kb, nothing is extracted -and the thing is never run) and the Chromium files are looked for in it. An -Electron AppImage is covered like any other app; a Tauri one is left alone, -because WebKitGTK simply has no autoscroll to switch on. - -## Commands - -| Command | | +| | | |---|---| -| `middleclick-autoscroll` | Interactive menu | -| `… enable` | Turn on, apply, start watching | +| `middleclick-autoscroll` | The menu | +| `… enable` | Turn on | | `… disable` | Undo everything | -| `… apply` | Apply to new apps | -| `… apply --rebuild` | Redo from scratch | -| `… status` | What's covered | -| `… list` | All apps and how they're handled | +| `… apply` | Pick up new apps | +| `… status` | What is covered | +| `… list` | All apps and how they are handled | -## Building from source +
+ +
+Build from source ```bash make sudo make install ``` -Optionally needs `msgfmt` (gettext) for translations and `scdoc` for the man -page. Supports `PREFIX` and `DESTDIR`. `make check` runs syntax checks and -shellcheck. +Optional: `msgfmt` for translations, `scdoc` for the man page. -See [packaging/README.md](packaging/README.md) for release builds and repo -signing. - -## License +
GPL-3.0-or-later.