Skip to content

Commit b0294df

Browse files
authored
docs(readme): standardize format to match template (#30)
- Centered header with logo, title, and tagline - Two rows of badges (License/Build, then Marketplace) - Consistent section structure with horizontal rules - Contributors section with markers - Centered footer with attribution
1 parent 4194902 commit b0294df

1 file changed

Lines changed: 57 additions & 49 deletions

File tree

README.md

Lines changed: 57 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,52 @@
1-
# 📂 Open Bin Folder
2-
3-
**🚀 Instantly open your project's output directory in Windows File Explorer!**
4-
5-
A Visual Studio 2022/2026 extension that adds a right-click context menu command to open the project's bin folder. It intelligently uses the currently active solution/project configuration to navigate to the correct output folder (Debug, Release, etc.).
6-
7-
---
8-
9-
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-OpenBinFolder?style=for-the-badge)](LICENSE)
10-
[![Build Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenBinFolder/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-OpenBinFolder/actions/workflows/build.yml)
11-
12-
[![VS Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder)
13-
[![VS Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder)
14-
[![VS Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder)
15-
[![VS Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder)
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-OpenBinFolder/main/resources/logo.png" alt="Open Bin Folder Logo" width="128" height="128">
3+
</p>
4+
5+
<h1 align="center">Open Bin Folder</h1>
6+
7+
<p align="center">
8+
<strong>Instantly open your project's output directory in Windows File Explorer!</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-OpenBinFolder/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-OpenBinFolder?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-OpenBinFolder/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenBinFolder/build.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
19+
20+
<p align="center">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge" alt="Marketplace Version">
23+
</a>
24+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge" alt="Marketplace Installations">
26+
</a>
27+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge" alt="Marketplace Downloads">
29+
</a>
30+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-OpenBinFolder?style=for-the-badge" alt="Marketplace Rating">
32+
</a>
33+
</p>
1634

1735
---
1836

19-
## ✨ Features
20-
21-
- **🖱️ Right-click to open** - Simple context menu integration in Solution Explorer
22-
- **⚙️ Configuration-aware** - Opens the correct bin folder based on your active build configuration
23-
- **⚡ Lightning fast** - No settings, no dialogs, just works!
37+
A Visual Studio 2022/2026 extension that adds a right-click context menu command to open the project's bin folder. It intelligently uses the currently active solution/project configuration to navigate to the correct output folder (Debug, Release, etc.).
2438

25-
---
39+
## Features
2640

27-
## 📦 Installation
41+
- **Right-click to open** - Simple context menu integration in Solution Explorer
42+
- **Configuration-aware** - Opens the correct bin folder based on your active build configuration
43+
- **Lightning fast** - No settings, no dialogs, just works!
2844

29-
### From Visual Studio Marketplace
45+
## Installation
3046

31-
[![VS Marketplace](https://img.shields.io/badge/VS%20Marketplace-Open%20Bin%20Folder-purple?style=for-the-badge&logo=visualstudio&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenBinFolder)
47+
### Visual Studio Marketplace
3248

33-
1. Open Visual Studio 2022
49+
1. Open Visual Studio 2022 or 2026
3450
2. Go to **Extensions > Manage Extensions**
3551
3. Search for "Open Bin Folder"
3652
4. Click **Download** and restart Visual Studio
@@ -39,51 +55,43 @@ A Visual Studio 2022/2026 extension that adds a right-click context menu command
3955

4056
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-OpenBinFolder/releases) page and double-click to install.
4157

42-
---
43-
44-
## 🎯 Usage
58+
## Usage
4559

4660
1. Right-click on any project in **Solution Explorer**
4761
2. Select **Open Bin Folder**
4862
3. Windows File Explorer opens to your project's output directory
4963

5064
That's it! The extension automatically detects your active configuration (Debug/Release) and opens the corresponding output folder.
5165

52-
---
66+
## Requirements
5367

54-
## 📋 Requirements
68+
- Visual Studio 2022 (17.0) or later
69+
- .NET Framework 4.8
5570

56-
- 💻 Visual Studio 2022 (17.0) or later
57-
- 🔧 .NET Framework 4.8
58-
59-
---
71+
## Contributing
6072

61-
## 🤝 Contributing
62-
63-
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. 💪
73+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
6474

6575
### Development Setup
6676

67-
1. 🍴 Clone the repository
68-
2. 📂 Open `src/CodingWithCalvin.OpenBinFolder.slnx` in Visual Studio 2022
69-
3. ▶️ Press F5 to launch the experimental instance
70-
71-
---
77+
1. Clone the repository
78+
2. Open `src/CodingWithCalvin.OpenBinFolder.slnx` in Visual Studio 2022 or 2026
79+
3. Ensure you have the "Visual Studio extension development" workload installed
80+
4. Press F5 to launch the experimental instance
7281

73-
## 📄 License
82+
## License
7483

75-
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
84+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
7685

7786
---
7887

79-
## 👥 Contributors
88+
## Contributors
8089

8190
<!-- readme: contributors -start -->
82-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) [![DavidsonAudioMulti](https://avatars.githubusercontent.com/u/47409222?v=4&s=64)](https://github.com/DavidsonAudioMulti) [![MikeCheel](https://avatars.githubusercontent.com/u/2339881?v=4&s=64)](https://github.com/MikeCheel)
8391
<!-- readme: contributors -end -->
8492

8593
---
8694

87-
**⭐ If you find Open Bin Folder useful, please consider giving it a star! ⭐**
88-
89-
*Made with ❤️ for the Visual Studio community by Coding With Calvin*
95+
<p align="center">
96+
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
97+
</p>

0 commit comments

Comments
 (0)