diff --git a/.readme/comparison.webp b/.readme/comparison.webp index d5c7cc0..a49fa17 100644 Binary files a/.readme/comparison.webp and b/.readme/comparison.webp differ diff --git a/README.md b/README.md index 67de203..200beac 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,24 @@ # ClipQture -Minimal context menu clipboard switcher. +A minimal clipboard assistant written in PyQt6. It brings back the previous +Plasma 6.1 (Kilpper) experience for the Clipboard's "Show at Mouse Position" shortcut. ClipQture = _**Clip**board for **Qt**/KDE desktops cap**ture** program._ - -## What's this? - -A minimal clipboard assistant written in PyQt6. It brings back the previous -Plasma (Kilpper) experience for the Clipboard's "Show at Mouse Position" shortcut. -Plasma 6.2 switched to showing the widget, as opposed to a simple context menu. - ![Comparison of clipqture and Klipper in Plasma 6.1 and 6.2](.readme/comparison.webp) It is designed to co-exist with the Plasma widget, although the clipboard state isn't -synchronised between the two programs. **Only text is supported** and -it's **designed for X11**. +synchronised between the two programs. It is designed for **selecting text** +and **X11 only**. + +Otherwise, this is how it works: -Otherwise, it listens to the clipboard and _captures_ recently copied text. -A global shortcut configured in your desktop environment (like **Meta+V**) executes -the program, which tells the first instance to open a context menu, -allowing for a quick change of the active clipboard for any text program. +* Listen to the clipboard and _capture_ recently copied text. +* A global shortcut configured in your desktop environment (like **Meta+V**) executes +the program, which tells the first instance to open a context menu. +* Use the context menu to quickly change the active clipboard text. -It extends functionality by showing the window icon where the text was copied from (X11 only). +It extends original functionality by showing the window icon where the text was copied from! ## Installation @@ -34,6 +30,8 @@ Grab a copy from [Releases]. Or, build a package using the supplied PKGBUILD: git clone https://github.com/lah7/clipqture.git makepkg -i +_(If this software is useful for many people_ ⭐, _I'll consider submitting it to the AUR.)_ + [Releases]: https://github.com/lah7/clipqture Next, use **KDE Menu Editor** to configure a shortcut key to launch this program. @@ -46,21 +44,23 @@ The program will be automatically started when you log in (`/etc/xdg/autostart`) ### Other Distributions & Environments -1. Make sure you have `python-pyqt6` and `python-setproctitle` installed. +1. Make sure you have the [Python dependencies] installed. 2. Copy the files: * `clipqture.py` to `~/.local/bin/` (you may need to update your PATH) * `clipqture.desktop` to `~/.local/share/applications/` - For the `.desktop` files, adjust the path of the `Exec=` line to point - to the full path for `clipqture.py`. + Edit the `.desktop` files to adjust the path of the `Exec=` line to point + to the full path where you placed `clipqture.py`. + +[Python dependencies]: PKGBUILD#10 Then, use your desktop environment to: * Set up a global shortcut that executes this file. * Add this script to run at startup. - * For example, in KDE, use **System Settings** > **Autostart**. In MATE, this is called **Start-up Applications**. + * For example, in KDE, use **System Settings** > **Autostart**. In MATE, use **Start-up Applications**. ## Configuration @@ -73,7 +73,7 @@ to apply changes. ## Why does it exist? Starting in Plasma 6.2.0, KDE's Klipper (Clipboard applet) went in a different -direction. The shortcut for _"Show Clipboard Items at Mouse Position"_ now opens +direction. The shortcut for _"Show Clipboard Items at Mouse Position"_ opens the full widget at the cursor. I used it often enough that it felt like a regression for this use case. @@ -81,17 +81,17 @@ From a UI perspective, the widget has more buttons, more padding per item, and buttons getting in the way. Context menus had a border, but the Plasma widget does not (there's a shadow, but it's shallow, making it look flat). Not to mention the widget takes up lots of vertical space that it may need -to scroll! +to scroll, and it has images and other data types I didn't need. -I was pretty happy and productive with the context menu, with one item per line, -this project brings back that simplicity. Other clipboard managers seemed too much. +I was pretty happy and productive with the old menu, with one item per line. +This project brings back that simplicity. Other clipboard managers seemed too much. Being written in Python, it's easy to modify and extend, and nobody can take that away! ## Tip: Don't make your clipboard forget! -**It is recommended to keep Klipper enabled,** with the "show at cursor" shortcut disabled. +**It is recommended to keep Klipper enabled,** but disable the "show at cursor" shortcut. This makes sure that the clipboard doesn't vanish if you copy text from a program and then close that same program.