Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 70 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,97 @@
# 🔴 Breakpoint Notifier
<p align="center">
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-BreakpointNotifier/main/resources/logo.png" alt="Breakpoint Notifier Logo" width="128" height="128">
</p>

A Visual Studio extension that monitors debugging events and displays a notification when a breakpoint is hit. Perfect for when you're waiting for that breakpoint during a long-running process while catching up on YouTube videos! 🎬
<h1 align="center">Breakpoint Notifier</h1>

![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-BreakpointNotifier?style=for-the-badge)
![Marketplace Installations](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-BreakpointNotifier?style=for-the-badge)
![License](https://img.shields.io/github/license/CodingWithCalvin/VS-BreakpointNotifier?style=for-the-badge)
![Build Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-BreakpointNotifier/build.yml?style=for-the-badge)
<p align="center">
<strong>🔴 Never miss a breakpoint again - get notified when debugging pauses!</strong>
</p>

<p align="center">
<a href="https://github.com/CodingWithCalvin/VS-BreakpointNotifier/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-BreakpointNotifier?style=for-the-badge" alt="License">
</a>
<a href="https://github.com/CodingWithCalvin/VS-BreakpointNotifier/actions/workflows/build.yml">
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-BreakpointNotifier/build.yml?style=for-the-badge" alt="Build Status">
</a>
</p>

<p align="center">
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Version">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Installations">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Downloads">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Rating">
</a>
</p>

---

## 🤔 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

- 🎯 **Smart Detection** - Notifies on breakpoint hits
- 💬 **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

<!-- readme: contributors -start -->
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) [![MarcolinoPT](https://avatars.githubusercontent.com/u/18648315?v=4&s=64)](https://github.com/MarcolinoPT)
<!-- readme: contributors -end -->

---

Made with ❤️ by [Coding With Calvin](https://github.com/CodingWithCalvin)
<p align="center">
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
</p>