Global shortcut setup: install scripts + docs for Linux, macOS, Windows#15
Global shortcut setup: install scripts + docs for Linux, macOS, Windows#15
Conversation
There was a problem hiding this comment.
Pull request overview
Adds cross-platform installation scripts and documentation to launch Screen Ruler via a global keyboard shortcut (without a persistent daemon), aligning with Issue #4’s goal of “summon-on-demand” usage.
Changes:
- Added Linux/macOS/Windows install scripts to copy the built binary and register a default global hotkey (or provide guided setup).
- Added a
.desktoptemplate and expanded documentation (README + manual setup guide) for platform-specific shortcut configuration.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
install-linux.sh |
Installs binary + .desktop entry and attempts DE-specific shortcut registration (GNOME/KDE/Hyprland/Sway). |
install-macos.sh |
Installs binary and generates an Automator Quick Action workflow plus shortcut-binding instructions. |
install-windows.ps1 |
Installs .exe, updates user PATH, and creates a Start Menu .lnk with a hotkey. |
screen-ruler.desktop |
Provides a baseline desktop entry template for Linux launchers. |
docs/manual-shortcut-setup.md |
Manual per-platform shortcut setup instructions for unsupported environments. |
README.md |
Adds a unified “Global keyboard shortcut” section with per-platform directions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dd4cf7d to
6f01208
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- install-linux.sh: copies binary, generates .desktop with correct Exec path, auto-registers Super+Shift+R shortcut (GNOME/KDE/Hyprland/Sway) - screen-ruler.desktop: static template for manual use - docs/manual-shortcut-setup.md: per-DE manual instructions - README: global shortcut section pointing to install script
- install-macos.sh: copies binary, generates an Automator Quick Action (.workflow) that launches screen-ruler, prints instructions for binding a keyboard shortcut in System Settings - Merge manual-shortcut-setup-macos.md into manual-shortcut-setup.md with Linux and macOS top-level sections - README: unified Global keyboard shortcut section with per-platform subsections
- install-windows.ps1: copies binary, adds to user PATH, creates a Start Menu .lnk shortcut with Ctrl+Shift+R hotkey via WScript.Shell - docs/manual-shortcut-setup.md: Windows section with .lnk, PowerToys, and AutoHotkey alternatives - README: Windows subsection under Global keyboard shortcut
Summary
Closes #4 — Provide a way to launch Screen Ruler with a global keyboard shortcut, without requiring a persistent daemon.
Changes
Linux (
install-linux.sh).desktopentry with correctExec=pathXDG_CURRENT_DESKTOP+ process fallback) and auto-registers Super+Shift+R:gsettingscustom keybinding (idempotent, finds next free slot)kwriteconfig5/kwriteconfig6→kglobalshortcutsrcbindtohyprland.confbindsymtosway/configupdate-desktop-databasemacOS (
install-macos.sh).workflow) that launches screen-rulerWindows (
install-windows.ps1)PATH.lnkshortcut with Ctrl+Shift+R hotkeyDocumentation
README.md: unified "Global keyboard shortcut" section with per-platform subsectionsdocs/manual-shortcut-setup.md: manual instructions for all platforms (Linux DEs, macOS Automator/Shortcuts/third-party, Windows .lnk/PowerToys/AutoHotkey)