From bf6cd28cd9e201548a92c0ed009f4baac674afa9 Mon Sep 17 00:00:00 2001
From: Manish Vasani <mavasani@microsoft.com>
Date: Thu, 17 Aug 2023 16:41:07 +0530
Subject: [PATCH] Add README file to Microsoft.CodeAnalysis.Analyzers NuGet
 package

Closes #6843
---
 .../Microsoft.CodeAnalysis.Analyzers.Package.csproj          | 2 ++
 src/Microsoft.CodeAnalysis.Analyzers/readme.md               | 5 +++++
 2 files changed, 7 insertions(+)
 create mode 100644 src/Microsoft.CodeAnalysis.Analyzers/readme.md

diff --git a/nuget/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.Package.csproj b/nuget/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.Package.csproj
index 27bfea4490..3e626f5195 100644
--- 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
new file mode 100644
index 0000000000..4fc038bf45
--- /dev/null
+++ 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)