Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated instructions for installing on different VS versions.
  • Loading branch information
pharring committed Jan 27, 2024
1 parent 0c3a5b3 commit b7b19e9
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Expand Up @@ -16,8 +16,23 @@ The extension adds vertical column guides behind your code. This is useful if yo
[![Visual Studio Marketplace Downloads](https://vsmarketplacebadges.dev/downloads-short/PaulHarrington.EditorGuidelines.svg)](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines)

## Getting Started
[Download](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines) and run the extension (VSIX) for Visual Studio 2012 or later from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines) or, from within Visual Studio, search for "Editor Guidelines" in the "Extensions and Updates" UI.

You can either download the extension (VSIX) from the Visual Studio Marketplace and manually install it, or intall it from within Visual Studio itself.

### Download from the Visual Studio Marketplace
There are two versions in the Visual Studio Marketplace
- [Download for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelinesPreview)
- [Download for Visual Studio 2015, 2017, 2019](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines)

Once downloaded, double-click on the downloaded file (.VSIX) and follow the prompts to install it into Visual Studio.

### Install from within Visual Studio
- Visual Studio 2019 and 2022: Select "Manage Extensions" on the "Extensions" menu. Search for "Editor Guidelines" in the Visual Studio Marketplace.
- Visual Studio 2015 and 2017: Select "Extensions and Updates..." from the "Tools" menu. Search for "Editor Guidelines" in the Visual Studio Marketplace.

You will then have to close and restart Visual Studio for the extension to be fully installed.

## Usage
Control guidelines via the context (right-click) menu on the editor surface. You will see a *Guidelines* flyout with three commands:

![GuidelinesContextMenu](marketplace/images/ContextMenu.png)
Expand All @@ -38,7 +53,7 @@ You can change the guideline color from the Fonts and Colors page in `Tools|Opti
![GuidelinesToolsOptions](marketplace/images/FontsAndColors.png)

## .editorconfig support (VS 2017 or above)
For VS 2017 and VS 2019, the position of guidelines can be overridden via settings in .editorconfig files.
For VS 2017, VS 2019 and VS 2022, the position of guidelines can be overridden via settings in .editorconfig files.
Set the `guidelines` property to a list of column values. The following example sets guidelines at columns 80 and 120 for C# and VB files and a single guideline at column 80 for all other files.

```ini
Expand Down

0 comments on commit b7b19e9

Please sign in to comment.