diff --git a/README.md b/README.md index a59807c..b564f0b 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,89 @@ -![logo64](https://raw.githubusercontent.com/QL-Win/SecondaryClick/refs/heads/master/branding/Logo64.png) +

+ SecondaryClick Logo +

-[![GitHub license](https://img.shields.io/github/license/QL-Win/SecondaryClick)](https://github.com/QL-Win/SecondaryClick/blob/master/LICENSE-GPL.txt) [![Actions](https://github.com/QL-Win/SecondaryClick/actions/workflows/build.yml/badge.svg)](https://github.com/QL-Win/SecondaryClick/actions/workflows/build.yml) [![Platform](https://img.shields.io/badge/platform-Windows-blue?logo=windowsxp&color=1E9BFA)](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48) +

πŸ–±οΈ SecondaryClick

-# SecondaryClick +

+ Bring macOS Secondary Click gestures to Windows. +

-Bring macOS β€œSecondary Click” gesture to Windows. +

+ License + Build Status + Platform +

-SecondaryClick lets you perform right-click actions from touchpad gestures and optional keyboard modifiers. +--- -## Features +SecondaryClick lets you perform right-click actions using touchpad gestures and optional keyboard modifiers. -- Secondary click support for touchpads -- Two-finger tap -- Bottom-right click zone -- Optional keyboard modifier triggers (`Alt`, `Control`, `Shift`) -- Lightweight system tray app +## ✨ Features -## Requirements +* πŸ–±οΈ Secondary click support for touchpads +* πŸ‘†πŸ‘† Two-finger tap +* πŸ“ Bottom-right click zone +* ⌨️ Optional keyboard modifier triggers (`Alt`, `Control`, `Shift`) +* πŸš€ Lightweight system tray app -- Windows with a touchpad -- .NET Framework 4.8 runtime -- Precision touchpad is recommended for full touchpad options +## πŸ“‹ Requirements -## Install +* πŸ’» Windows with a touchpad +* βš™οΈ .NET Framework 4.8 runtime +* 🎯 Precision touchpad recommended for full touchpad functionality -Download the latest build from [Releases](https://github.com/QL-Win/SecondaryClick/releases). +## πŸ“¦ Install -## Usage +Download the latest build from **[Releases](https://github.com/QL-Win/SecondaryClick/releases)**. + +## πŸš€ Usage After launch, SecondaryClick runs in the system tray. -- Right-click the tray icon to open settings -- Enable or disable touchpad gestures: - - Two-finger tap - - Bottom-right click -- Enable keyboard-assisted triggers: - - Off - - Alt Key - - Control Key - - Shift Key -- Optional: enable Start with Windows from tray menu -- Optional: hide tray icon from tray menu (`Hide tray icon`) +### πŸ‘† Touchpad Gestures + +Enable or disable: + +* πŸ‘†πŸ‘† Two-finger tap +* πŸ“ Bottom-right click + +### ⌨️ Keyboard-Assisted Triggers + +Choose one of: + +* Off +* `Alt` Key +* `Control` Key +* `Shift` Key + +### βš™οΈ Additional Options + +* πŸ–±οΈ Right-click the tray icon to open settings +* πŸ”„ Enable **Start with Windows** from the tray menu +* πŸ‘» Hide the tray icon using **Hide tray icon** + +If the tray icon is hidden, run: + +```bat +RestoreTrayIcon.bat +``` -If tray icon is hidden, run `RestoreTrayIcon.bat` from the app output folder to restore it. +from the application output folder to restore it. -Settings are saved per user and restored automatically on next launch. +πŸ’Ύ Settings are saved per user and automatically restored on the next launch. -## Designer +## 🎨 Designer -Application icon designed by [@Shomnipotence](https://github.com/Shomnipotence) +Application icon designed by **[@Shomnipotence](https://github.com/Shomnipotence)**. -## License +## πŸ“œ License -GPL v3 +

+ GPL v3 +

-`SecondaryClick` is free and open source software under [GPL-3.0](https://opensource.org/licenses/GPL-3.0). +πŸ”“ `SecondaryClick` is free and open-source software licensed under **GPL-3.0**. -`SecondaryClick.MouseKeyHook` is based on [MouseKeyHook](https://github.com/gmamaladze/globalmousekeyhook) and distributed under [MIT](https://github.com/gmamaladze/globalmousekeyhook#MIT-1-ov-file). +πŸ”§ `SecondaryClick.MouseKeyHook` is based on **MouseKeyHook** and distributed under the **MIT License**. -`SecondaryClick.WindowsInput` is based on [InputSimulator](https://github.com/michaelnoonan/inputsimulator) and distributed under [MIT](https://github.com/michaelnoonan/inputsimulator?tab=MIT-1-ov-file#readme). +πŸ”§ `SecondaryClick.WindowsInput` is based on **InputSimulator** and distributed under the **MIT License**.