Commit3587540

authored

Merge pull request#6859 from mavasani/AddReadme

Add README file to Microsoft.CodeAnalysis.Analyzers NuGet package

2 parents47c7281 +bf6cd28 commit3587540Copy full SHA for 3587540

File tree

-0

lines changed

nuget/Microsoft.CodeAnalysis.Analyzers
- Microsoft.CodeAnalysis.Analyzers.Package.csproj
src/Microsoft.CodeAnalysis.Analyzers
- readme.md

-0

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`<Summary>Analyzers for .NET Compiler Platform ("Roslyn")</Summary>`
`10`	`10`	`<ReleaseNotes>Diagnostic analyzers for the Microsoft .NET Compiler Platform (Roslyn)</ReleaseNotes>`
`11`	`11`	`<PackageTags>Roslyn CodeAnalysis Compiler CSharp VB VisualBasic Diagnostic Analyzers Syntax Semantics</PackageTags>`
	`12`	`+ <PackageReadmeFile>documentation\readme.md</PackageReadmeFile>`
`12`	`13`	`<IsShippingPackage>true</IsShippingPackage>`
`13`	`14`
`14`	`15`	`<!--`
`@@ -22,6 +23,7 @@`
`22`	`23`	`<AnalyzerNupkgAssemblyInclude="Microsoft.CodeAnalysis.Analyzers.dll" />`
`23`	`24`	`<AnalyzerNupkgAssemblyInclude="Microsoft.CodeAnalysis.CSharp.Analyzers.dll" />`
`24`	`25`	`<AnalyzerNupkgAssemblyInclude="Microsoft.CodeAnalysis.VisualBasic.Analyzers.dll" />`
	`26`	`+ <PackageReadmeFileSourceInclude="..\..\src\Microsoft.CodeAnalysis.Analyzers\readme.md"/>`
`25`	`27`	`</ItemGroup>`
`26`	`28`
`27`	`29`	`<ItemGroup>`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,5 @@`
	`1`	`+#Microsoft.CodeAnalysis.Analyzers`
	`2`	`+`
	`3`	+Contains rules for correct usage of APIs from the[Microsoft.CodeAnalysis](https://www.nuget.org/packages/Microsoft.CodeAnalysis) NuGet package, i.e. .NET Compiler Platform ("Roslyn") APIs. These are primarily aimed towards helping authors of diagnostic analyzers, code fix providers and other tools built on top of Microsoft.CodeAnalysis to invoke the Microsoft.CodeAnalysis APIs in a recommended manner. This package is included as a development dependency of[Microsoft.CodeAnalysis](https://www.nuget.org/packages/Microsoft.CodeAnalysis) NuGet package, and does not need to be installed separately if you are referencing Microsoft.CodeAnalysis NuGet package.
	`4`	`+`
	`5`	`+[More info about rules in this package](./Microsoft.CodeAnalysis.Analyzers.md)`

Comments

(0)