Skip to content

Commit 0b97c43

Browse files
committed
Add installation and override instructions to README
1 parent 9163ceb commit 0b97c43

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
Library for enforcing my preferred conventions in C#.
44

5+
## Installation
6+
7+
The easiest way to install this package is to add a line something like the
8+
following to your `.csproj` file:
9+
10+
```xml
11+
<PackageReference Include="Tdg5.StandardConventions" PrivateAssets="all" Version="0.0.2" />
12+
```
13+
14+
It's important that you include `PrivateAssets="all"` to avoid including
15+
analyzers and other development packages in your run-time builds.
16+
17+
18+
## Overriding configurations
19+
20+
Since this project provides global configurations, most configurations can be
21+
overridden by adding a `.editorconfig` file to your project with your desired
22+
overrides. Learn more here: [Configuration files for code analysis
23+
rules](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files).
24+
25+
526
## Running Tests
627

728
Test are run against packed versions of the library. Because of this, NuGet

0 commit comments

Comments
 (0)