diff --git a/README.md b/README.md index 9d35f53..3797c97 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,42 @@ -# 🔴 Breakpoint Notifier +
+
+
+ 🔴 Never miss a breakpoint again - get notified when debugging pauses! +
+ + + + + +--- + +## 🤔 Why? + +Waiting for that breakpoint to hit during a long-running process while catching up on YouTube videos? This extension monitors debugging events and displays a notification when a breakpoint is hit - so you never miss it! 🎬 ## ✨ Features @@ -13,31 +44,54 @@ A Visual Studio extension that monitors debugging events and displays a notifica - 💬 **Flexible Notifications** - Choose between Windows toast notifications, classic message box, or both! - ⚙️ **Configurable** - Customize your notification style via Tools > Options - 🖥️ **Multi-Architecture** - Supports both x64 and ARM64 systems -- 🚀 **VS 2022 & 2026** - Compatible with Visual Studio 2022 and Visual Studio 2026 -## 🔧 Configuration +## 🛠️ Installation + +### Visual Studio Marketplace + +1. Open Visual Studio 2022 or 2026 +2. Go to **Extensions > Manage Extensions** +3. Search for "Breakpoint Notifier" +4. Click **Download** and restart Visual Studio -Configure your preferred notification style: +### Manual Installation -1. Go to **Tools** > **Options** -2. Navigate to **Breakpoint Notifier** > **General** +Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-BreakpointNotifier/releases) page and double-click to install. + +## 🚀 Usage + +1. Install the extension and restart Visual Studio +2. Go to **Tools > Options > Breakpoint Notifier > General** 3. Select your **Notification Style**: - 🔔 **Toast** (default) - Non-intrusive Windows toast notification - 📦 **MessageBox** - Classic message box that steals focus - 🔔📦 **Both** - Get both notifications at once +4. Start debugging and wait for that breakpoint! 🎉 + +## 🤝 Contributing + +Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. -## 🤝 Contribute +### Development Setup -Contributions are welcome! Issues, PRs, etc. While it may seem this extension is "done", who knows what the future may hold for it? 🔮 +1. Clone the repository +2. Open the solution in Visual Studio 2022 or 2026 +3. Ensure you have the "Visual Studio extension development" workload installed +4. Press F5 to launch the experimental instance -For cloning and building this project yourself, make sure to install the [Extensibility Essentials 2022 extension](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) for Visual Studio which enables some features used by this project. +## 📄 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- ## 👥 Contributors -[](https://github.com/CalvinAllen) [](https://github.com/MarcolinoPT) --- -Made with ❤️ by [Coding With Calvin](https://github.com/CodingWithCalvin) ++ Made with ❤️ by Coding With Calvin +