Add install.ps1 and update README with install docs

This commit is contained in:
2026-06-30 17:02:44 -07:00
parent b6cb6e0969
commit a8de8f95c0
2 changed files with 57 additions and 2 deletions

View File

@@ -10,12 +10,22 @@ FuckCapsLock installs a low-level Windows keyboard hook (`WH_KEYBOARD_LL` — `S
No driver, no service, no admin rights required. It's a single-user-mode userland hook that runs in your session's context.
## Usage
## Quick Install
Run the included `install.ps1` as Administrator from the repo root:
```powershell
# Right-click install.ps1 -> Run with PowerShell (Run as Administrator)
```
This copies `fuckcapslock.exe` to `C:\Program Files\FuckCapsLock\`, sets up auto-start in the registry (HKLM — all users), and launches the app immediately.
## Usage (Manual)
1. Run `fuckcapslock.exe` — it minimizes to the system tray immediately
2. Caps Lock is now permanently disabled — pressing it does nothing
3. To restore Caps Lock, right-click the tray icon and select **Exit**
4. The app registers itself in `HKCU\Software\Microsoft\Windows\CurrentVersion\Run` for auto-start on next boot
4. Without the installer, the app registers itself in `HKCU\Software\Microsoft\Windows\CurrentVersion\Run` on first launch for per-user auto-start
## Build