Skip to content

Commit 8b11a22

Browse files
authored
docs(readme): standardize format to match template (#42)
- 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 2ef522b commit 8b11a22

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,51 @@
55
<h1 align="center">Open in Notepad++</h1>
66

77
<p align="center">
8-
<strong>🚀 Instantly open any file from Visual Studio in Notepad++!</strong>
8+
<strong>Instantly open any file from Visual Studio in Notepad++!</strong>
99
</p>
1010

1111
<p align="center">
1212
<a href="https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/blob/main/LICENSE">
1313
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="License">
1414
</a>
15-
<a href="https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/actions/workflows/release_build_and_deploy.yml">
16-
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenInNotepadPlusPlus/release_build_and_deploy.yml?style=for-the-badge" alt="Build Status">
15+
<a href="https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenInNotepadPlusPlus/build.yml?style=for-the-badge" alt="Build Status">
1717
</a>
1818
</p>
1919

2020
<p align="center">
21-
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
22-
<img src="https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Version">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenInNotepadPlusPlus">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Version">
2323
</a>
24-
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
25-
<img src="https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Installations">
24+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenInNotepadPlusPlus">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Installations">
2626
</a>
27-
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
28-
<img src="https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Downloads">
27+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenInNotepadPlusPlus">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Downloads">
2929
</a>
30-
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
31-
<img src="https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Rating">
30+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-OpenInNotepadPlusPlus">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Rating">
3232
</a>
3333
</p>
3434

3535
---
3636

37-
## Features
37+
## Features
3838

3939
- **Right-click to open** - Open any file directly from Solution Explorer
4040
- **Works everywhere** - Solutions, projects, folders, and individual files
4141
- **Auto-detection** - Automatically finds Notepad++ in the default install location
4242
- **Configurable** - Custom executable path via Tools > Options
4343

44-
## 📋 Prerequisites
44+
## Prerequisites
4545

4646
This extension requires [Notepad++](https://notepad-plus-plus.org/) to be installed on your machine.
4747

48-
## ⚙️ Configuration
49-
50-
The extension automatically detects `notepad++.exe` in the default installation directory. If you've installed Notepad++ to a custom location, configure the path in **Tools > Options > Open in Notepad++**.
51-
52-
## 🛠️ Installation
48+
## Installation
5349

5450
### Visual Studio Marketplace
5551

56-
1. Open Visual Studio 2022
52+
1. Open Visual Studio 2022 or 2026
5753
2. Go to **Extensions > Manage Extensions**
5854
3. Search for "Open in Notepad++"
5955
4. Click **Download** and restart Visual Studio
@@ -62,28 +58,34 @@ The extension automatically detects `notepad++.exe` in the default installation
6258

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

65-
## 🤝 Contributing
61+
## Configuration
62+
63+
The extension automatically detects `notepad++.exe` in the default installation directory. If you've installed Notepad++ to a custom location, configure the path in **Tools > Options > Open in Notepad++**.
64+
65+
## Contributing
6666

6767
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
6868

6969
### Development Setup
7070

7171
1. Clone the repository
72-
2. Open `src/CodingWithCalvin.OpenInNotepadPlusPlus.slnx` in Visual Studio
73-
3. Press F5 to launch the experimental instance
72+
2. Open `src/CodingWithCalvin.OpenInNotepadPlusPlus.slnx` in Visual Studio 2022 or 2026
73+
3. Ensure you have the "Visual Studio extension development" workload installed
74+
4. Press F5 to launch the experimental instance
7475

75-
## 📄 License
76+
## License
7677

7778
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
7879

7980
---
8081

81-
## 👥 Contributors
82+
## Contributors
8283

8384
<!-- readme: contributors -start -->
84-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) [![Mertsch](https://avatars.githubusercontent.com/u/9402861?v=4&s=64)](https://github.com/Mertsch) [![randolm](https://avatars.githubusercontent.com/u/67427043?v=4&s=64)](https://github.com/randolm)
8585
<!-- readme: contributors -end -->
8686

87+
---
88+
8789
<p align="center">
88-
Made with ❤️ by <a href="https://github.com/CalvinAllen">Coding With Calvin</a>
90+
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
8991
</p>

0 commit comments

Comments
 (0)