Skip to content

Commit 07ed8f9

Browse files
CalvinAllenCalvinAllen
authored
docs(readme): modernize README with vibrant formatting (#26)
- Add emojis throughout for visual appeal - Add proper badge links to marketplace and GitHub - Add Features, Installation, Usage, and Requirements sections - Remove Extensibility Essentials requirement from dev setup - Use pure Markdown formatting (no HTML) - Follow CodingWithCalvin repo README conventions
1 parent 4735db1 commit 07ed8f9

1 file changed

Lines changed: 75 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 75 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,89 @@
1-
# Open Bin Folder
1+
# 📂 Open Bin Folder
22

3-
A Visual Studio extension that adds a right-click context menu command that allows you to open the project's output directory (i.e, the "bin" folder) in Windows File Explorer. This uses the currently active solution/project configuration to determin *WHICH* output folder to navigate to.
3+
**🚀 Instantly open your project's output directory in Windows File Explorer!**
44

5-
## License
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.).
66

7-
[![License - MIT](https://img.shields.io/github/license/codingwithcalvin/vs-OpenBinFolder?style=for-the-badge)](https://img.shields.io/github/license/codingwithcalvin/vs-OpenBinFolder?style=for-the-badge)
7+
---
88

9-
## Build Status
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)
1011

11-
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/codingwithcalvin/vs-OpenBinFolder/release_build_and_deploy.yml?style=for-the-badge)
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)
1216

13-
## Marketplace Status
17+
---
1418

15-
[![Marketplace Installations](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge) [![Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)
16-
[![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge) [![Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.vs-OpenBinFolder?style=for-the-badge)
19+
## ✨ Features
1720

18-
## Contribute
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!
1924

20-
Contributions are welcome! Issues, PRs, etc. While it may seem this extension is "done", who knows what the future may hold for it?
25+
---
2126

22-
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.
27+
## 📦 Installation
2328

24-
## Contributors
29+
### From Visual Studio Marketplace
30+
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)
32+
33+
1. Open Visual Studio 2022
34+
2. Go to **Extensions > Manage Extensions**
35+
3. Search for "Open Bin Folder"
36+
4. Click **Download** and restart Visual Studio
37+
38+
### Manual Installation
39+
40+
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-OpenBinFolder/releases) page and double-click to install.
41+
42+
---
43+
44+
## 🎯 Usage
45+
46+
1. Right-click on any project in **Solution Explorer**
47+
2. Select **Open Bin Folder**
48+
3. Windows File Explorer opens to your project's output directory
49+
50+
That's it! The extension automatically detects your active configuration (Debug/Release) and opens the corresponding output folder.
51+
52+
---
53+
54+
## 📋 Requirements
55+
56+
- 💻 Visual Studio 2022 (17.0) or later
57+
- 🔧 .NET Framework 4.8
58+
59+
---
60+
61+
## 🤝 Contributing
62+
63+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. 💪
64+
65+
### Development Setup
66+
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+
---
72+
73+
## 📄 License
74+
75+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
76+
77+
---
78+
79+
## 👥 Contributors
2580

2681
<!-- readme: contributors -start -->
27-
[![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)
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)
2883
<!-- readme: contributors -end -->
84+
85+
---
86+
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*

0 commit comments

Comments
 (0)