Add README file to Microsoft.CodeAnalysis.Analyzers NuGet package

Closes #6843
dotnet · Aug 17, 2023 · bf6cd28 · bf6cd28
1 parent 28fbf11
commit bf6cd28
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/nuget/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.Package.csproj b/nuget/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.Package.csproj
@@ -9,6 +9,7 @@
     <Summary>Analyzers for .NET Compiler Platform ("Roslyn")</Summary>
     <ReleaseNotes>Diagnostic analyzers for the Microsoft .NET Compiler Platform (Roslyn)</ReleaseNotes>
     <PackageTags>Roslyn CodeAnalysis Compiler CSharp VB VisualBasic Diagnostic Analyzers Syntax Semantics</PackageTags>
+    <PackageReadmeFile>documentation\readme.md</PackageReadmeFile>
     <IsShippingPackage>true</IsShippingPackage>
 
     <!-- 
@@ -22,6 +23,7 @@
     <AnalyzerNupkgAssembly Include="Microsoft.CodeAnalysis.Analyzers.dll" />
     <AnalyzerNupkgAssembly Include="Microsoft.CodeAnalysis.CSharp.Analyzers.dll" />
     <AnalyzerNupkgAssembly Include="Microsoft.CodeAnalysis.VisualBasic.Analyzers.dll" />
+    <PackageReadmeFileSource Include="..\..\src\Microsoft.CodeAnalysis.Analyzers\readme.md"/>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Microsoft.CodeAnalysis.Analyzers/readme.md b/src/Microsoft.CodeAnalysis.Analyzers/readme.md
@@ -0,0 +1,5 @@
+# Microsoft.CodeAnalysis.Analyzers
+
+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.
+
+[More info about rules in this package](./Microsoft.CodeAnalysis.Analyzers.md)