Add readme to nuget packages (#908)

dotnet · May 29, 2022 · 9f13ab5 · 9f13ab5
1 parent 54a3fb7
commit 9f13ab5
Show file tree

Hide file tree

Showing 24 changed files with 331 additions and 28 deletions.
diff --git a/src/Analyzers.CodeFixes/Roslynator.Analyzers.nuspec b/src/Analyzers.CodeFixes/Roslynator.Analyzers.nuspec
@@ -6,7 +6,7 @@
     <authors>Josef Pihrt</authors>
     <owners>Josef Pihrt</owners>
     <license type="expression">Apache-2.0</license>
-    <projectUrl>http://github.com/JosefPihrt/Roslynator</projectUrl>
+    <projectUrl>https://github.com/josefpihrt/roslynator</projectUrl>
     <icon>icon.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>A collection of 200+ analyzers for C#, powered by Roslyn.
@@ -16,11 +16,13 @@
     <copyright>Copyright (c) 2016-2022 Josef Pihrt</copyright>
     <tags>Roslyn Analyzer Refactoring Productivity CodeAnalysis C# CSharp</tags>
     <developmentDependency>true</developmentDependency>
-    <repository type="git" url="https://github.com/JosefPihrt/Roslynator.git" />
+    <repository type="git" url="https://github.com/josefpihrt/roslynator.git" />
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="bin\$Configuration$\netstandard2.0\Roslynator*.dll" target="analyzers\dotnet\cs" />
     <file src="tools\*.ps1" target="tools\" />
     <file src="..\..\images\icon.png" target="" />
+    <file src="docs\NuGetReadme.md" target="docs\README.md" />
   </files>
 </package>
diff --git a/src/Analyzers.CodeFixes/docs/NuGetReadme.md b/src/Analyzers.CodeFixes/docs/NuGetReadme.md
@@ -0,0 +1,30 @@
+# Roslynator.Analyzers
+
+A collection of 200+ analyzers for C#, powered by [Roslyn](https://github.com/dotnet/roslyn).
+
+## Requirements
+
+* Visual Studio 2022
+* VS Code with [C# for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) 1.21.13 or higher
+* Roslyn 4.0.1 (when used directly, not as a part of IDE)
+
+## Usage
+
+* Add package to your project:
+   ```shell
+   dotnet add package roslynator.formatting.analyzers
+   ```
+
+* Use EditorConfig to [configure](https://github.com/josefpihrt/roslynator/blob/master/docs/Configuration.md) analyzers.
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Command-line Tool](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/CSharp.Workspaces/CSharp.Workspaces.csproj b/src/CSharp.Workspaces/CSharp.Workspaces.csproj
@@ -28,11 +28,12 @@ Roslynator.CSharp.SyntaxInfo
 Roslynator.NameGenerator</Description>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <PackageProjectUrl>https://github.com/JosefPihrt/Roslynator</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/josefpihrt/roslynator</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
     <PackageReleaseNotes></PackageReleaseNotes>
     <PackageTags>Roslyn;Analyzer;Refactoring;Productivity;CodeAnalysis;C#;CSharp</PackageTags>
-    <RepositoryUrl>https://github.com/JosefPihrt/Roslynator.git</RepositoryUrl>
+    <PackageReadmeFile>docs/README.md</PackageReadmeFile>
+    <RepositoryUrl>https://github.com/josefpihrt/roslynator.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
@@ -48,6 +49,7 @@ Roslynator.NameGenerator</Description>
 
   <ItemGroup>
     <None Include="..\..\images\icon.png" Pack="true" PackagePath="\" Visible="false" />
+    <None Include="docs\NuGetReadme.md" Pack="true" PackagePath="docs\README.md" />
   </ItemGroup>
 
 </Project>
diff --git a/src/CSharp.Workspaces/docs/NuGetReadme.md b/src/CSharp.Workspaces/docs/NuGetReadme.md
@@ -0,0 +1,15 @@
+# Roslynator.CSharp.Workspaces
+
+This package extends functionality of package [Microsoft.CodeAnalysis.CSharp.Workspaces](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp.Workspaces).
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Command-line Tool](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/CSharp/CSharp.csproj b/src/CSharp/CSharp.csproj
@@ -28,11 +28,12 @@ Roslynator.CSharp.SyntaxInfo
 Roslynator.NameGenerator</Description>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <PackageProjectUrl>https://github.com/JosefPihrt/Roslynator</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/josefpihrt/roslynator</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
     <PackageReleaseNotes></PackageReleaseNotes>
     <PackageTags>Roslyn;Analyzer;Refactoring;Productivity;CodeAnalysis;C#;CSharp</PackageTags>
-    <RepositoryUrl>https://github.com/JosefPihrt/Roslynator.git</RepositoryUrl>
+    <PackageReadmeFile>docs/README.md</PackageReadmeFile>
+    <RepositoryUrl>https://github.com/josefpihrt/roslynator.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
@@ -47,6 +48,7 @@ Roslynator.NameGenerator</Description>
 
   <ItemGroup>
     <None Include="..\..\images\icon.png" Pack="true" PackagePath="\" Visible="false" />
+    <None Include="docs\NuGetReadme.md" Pack="true" PackagePath="docs\README.md" />
   </ItemGroup>
 
 </Project>
diff --git a/src/CSharp/docs/NuGetReadme.md b/src/CSharp/docs/NuGetReadme.md
@@ -0,0 +1,15 @@
+# Roslynator.CSharp
+
+This package extends functionality of package [Microsoft.CodeAnalysis.CSharp](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp).
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Command-line Tool](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/CodeAnalysis.Analyzers.CodeFixes/Roslynator.CodeAnalysis.Analyzers.nuspec b/src/CodeAnalysis.Analyzers.CodeFixes/Roslynator.CodeAnalysis.Analyzers.nuspec
@@ -6,22 +6,24 @@
     <authors>Josef Pihrt</authors>
     <owners>Josef Pihrt</owners>
     <license type="expression">Apache-2.0</license>
-    <projectUrl>http://github.com/JosefPihrt/Roslynator</projectUrl>
+    <projectUrl>https://github.com/josefpihrt/roslynator</projectUrl>
     <icon>icon.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>A collection of analyzers for Roslyn API.
 
   - This package is dependent on Microsoft.CodeAnalysis.CSharp.Workspaces 4.0.1.
-  - This package is applicable for projects that use Roslyn API (Microsoft.CodeAnalysis* packages)</description>
+  - This package is applicable for projects that reference Roslyn packages (Microsoft.CodeAnalysis*), otherwise it has no effect.</description>
     <summary>A collection of analyzers for Roslyn API.</summary>
     <copyright>Copyright (c) 2016-2022 Josef Pihrt</copyright>
     <tags>Roslyn Analyzer CodeAnalysis C# CSharp</tags>
     <developmentDependency>true</developmentDependency>
-    <repository type="git" url="https://github.com/JosefPihrt/Roslynator.git" />
+    <repository type="git" url="https://github.com/josefpihrt/roslynator.git" />
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="bin\$Configuration$\netstandard2.0\Roslynator*.dll" target="analyzers\dotnet\cs" />
     <file src="tools\*.ps1" target="tools\" />
     <file src="..\..\images\icon.png" target="" />
+    <file src="docs\NuGetReadme.md" target="docs\README.md" />
   </files>
 </package>
diff --git a/src/CodeAnalysis.Analyzers.CodeFixes/docs/NuGetReadme.md b/src/CodeAnalysis.Analyzers.CodeFixes/docs/NuGetReadme.md
@@ -0,0 +1,32 @@
+# Roslynator.CodeAnalysis.Analyzers
+
+A collection of analyzers for Roslyn API, powered by [Roslyn](https://github.com/dotnet/roslyn).
+
+The package is applicable for projects that reference Roslyn packages (Microsoft.CodeAnalysis*), otherwise it has no effect.
+
+## Requirements
+
+* Visual Studio 2022
+* VS Code with [C# for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) 1.21.13 or higher
+* Roslyn 4.0.1 (when used directly, not as a part of IDE)
+
+## Usage
+
+* Add package to your project:
+   ```shell
+   dotnet add package roslynator.formatting.analyzers
+   ```
+
+* Use EditorConfig to [configure](https://github.com/josefpihrt/roslynator/blob/master/docs/Configuration.md) analyzers.
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Command-line Tool](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/CommandLine/CommandLine.csproj b/src/CommandLine/CommandLine.csproj
@@ -26,12 +26,13 @@
     <PackageId>Roslynator.DotNet.Cli</PackageId>
     <PackageVersion>$(RoslynatorCliPackageVersion)</PackageVersion>
     <Authors>Josef Pihrt</Authors>
-    <Description>Roslynator command line tool for .NET Core</Description>
-    <PackageProjectUrl>https://github.com/JosefPihrt/Roslynator</PackageProjectUrl>
+    <Description>Roslynator command-line tool for .NET Core</Description>
+    <PackageProjectUrl>https://github.com/josefpihrt/roslynator</PackageProjectUrl>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <PackageIcon>icon.png</PackageIcon>
     <PackageTags>CLI;Roslyn;C#;CSharp</PackageTags>
-    <RepositoryUrl>https://github.com/JosefPihrt/Roslynator.git</RepositoryUrl>
+    <PackageReadmeFile>docs/README.md</PackageReadmeFile>
+    <RepositoryUrl>https://github.com/josefpihrt/roslynator.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
   </PropertyGroup>
@@ -63,6 +64,7 @@
 
   <ItemGroup>
     <None Include="..\..\images\icon.png" Pack="true" PackagePath="\" Visible="false" />
+    <None Include="docs\NetCore\NuGetReadme.md" Pack="true" PackagePath="docs\README.md" />
     <None Remove="_._" />
   </ItemGroup>
 

diff --git a/src/CommandLine/CommandLine.nuspec b/src/CommandLine/CommandLine.nuspec
@@ -6,15 +6,16 @@
     <authors>Josef Pihrt</authors>
     <owners>Josef Pihrt</owners>
     <license type="expression">Apache-2.0</license>
-    <projectUrl>https://github.com/JosefPihrt/Roslynator</projectUrl>
+    <projectUrl>https://github.com/josefpihrt/roslynator</projectUrl>
     <icon>icon.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <description>Roslynator command line tool</description>
-    <summary>Roslynator command line tool</summary>
+    <description>Roslynator command-line tool</description>
+    <summary>Roslynator command-line tool</summary>
     <copyright>Copyright (c) 2017-2022 Josef Pihrt</copyright>
     <tags>CLI Roslyn C# CSharp VB VisualBasic</tags>
     <developmentDependency>true</developmentDependency>
-    <repository type="git" url="https://github.com/JosefPihrt/Roslynator.git" />
+    <repository type="git" url="https://github.com/josefpihrt/roslynator.git" />
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="_._" target="lib/net45/" />
@@ -24,5 +25,6 @@
     <file src="Roslynator.targets" target="tools/" />
     <file src="$publishDir$net48\**\*" target="tools/net48/" exclude="**\*.pdb;**\*.xml" />
     <file src="..\..\images\icon.png" target="" />
+    <file src="docs\NetFramework\NuGetReadme.md" target="docs\README.md" />
   </files>
 </package>
diff --git a/src/CommandLine/docs/NetCore/NuGetReadme.md b/src/CommandLine/docs/NetCore/NuGetReadme.md
@@ -0,0 +1,39 @@
+# Roslynator Command-line Tool
+
+.NET Core global tool that allows to run [Roslyn](https://github.com/dotnet/roslyn) code analysis from command line.
+
+## Requirements
+
+.NET Core SDK 5.0 or 6.0.
+
+## Installation
+
+Run following command to install Roslynator command-line tool:
+```shell
+dotnet tool install -g roslynator.dotnet.cli
+```
+
+## Usage
+
+Analyze project/solution:
+```shell
+roslynator analyze
+```
+
+Fix project/solution:
+```shell
+roslynator fix
+```
+
+See [documentation](https://github.com/josefpihrt/roslynator/blob/master/docs/cli/README.md) for a full list of commands.
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/CommandLine/docs/NetFramework/NuGetReadme.md b/src/CommandLine/docs/NetFramework/NuGetReadme.md
@@ -0,0 +1,36 @@
+# Roslynator Command-line Tool
+
+.NET Framework stand-alone application that allows to run [Roslyn](https://github.com/dotnet/roslyn) code analysis from command line.
+
+## Requirements
+
+.NET Framework 4.8 or higher.
+
+## Installation
+
+No installation required, just run roslynator.exe.
+
+## Usage
+
+Analyze project/solution:
+```shell
+roslynator analyze
+```
+
+Fix project/solution:
+```shell
+roslynator fix
+```
+
+See [documentation](https://github.com/josefpihrt/roslynator/blob/master/docs/cli/README.md) for a full list of commands.
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/Core/Core.csproj b/src/Core/Core.csproj
@@ -22,11 +22,12 @@
     <Description>This library extends functionality of package Microsoft.CodeAnalysis.Common.</Description>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <PackageProjectUrl>https://github.com/JosefPihrt/Roslynator</PackageProjectUrl>
+    <PackageProjectUrl>https://github.com/josefpihrt/roslynator</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
     <PackageReleaseNotes></PackageReleaseNotes>
     <PackageTags>Roslyn;CodeAnalysis</PackageTags>
-    <RepositoryUrl>https://github.com/JosefPihrt/Roslynator.git</RepositoryUrl>
+    <PackageReadmeFile>docs/README.md</PackageReadmeFile>
+    <RepositoryUrl>https://github.com/josefpihrt/roslynator.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
@@ -36,6 +37,7 @@
 
   <ItemGroup>
     <None Include="..\..\images\icon.png" Pack="true" PackagePath="\" Visible="false" />
+    <None Include="docs\NuGetReadme.md" Pack="true" PackagePath="docs\README.md" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Core/docs/NuGetReadme.md b/src/Core/docs/NuGetReadme.md
@@ -0,0 +1,15 @@
+# Roslynator.Core
+
+This package extends functionality of package [Microsoft.CodeAnalysis.Common](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Common).
+
+## Feedback
+
+* File an issue on [GitHub](https://github.com/josefpihrt/roslynator/issues/new)
+* Follow on [Twitter](https://twitter.com/roslynator)
+
+## Related Products
+
+* [Roslynator for Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
+* [Roslynator for VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
+* [Roslynator Command-line Tool](https://www.nuget.org/packages/Roslynator.DotNet.Cli)
+* [Roslynator Testing Framework](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit)
diff --git a/src/Formatting.Analyzers.CodeFixes/Roslynator.Formatting.Analyzers.nuspec b/src/Formatting.Analyzers.CodeFixes/Roslynator.Formatting.Analyzers.nuspec
@@ -6,7 +6,7 @@
     <authors>Josef Pihrt</authors>
     <owners>Josef Pihrt</owners>
     <license type="expression">Apache-2.0</license>
-    <projectUrl>http://github.com/JosefPihrt/Roslynator</projectUrl>
+    <projectUrl>https://github.com/josefpihrt/roslynator</projectUrl>
     <icon>icon.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>A collection of formatting analyzers, powered by Roslyn.
@@ -17,11 +17,13 @@
     <copyright>Copyright (c) 2016-2022 Josef Pihrt</copyright>
     <tags>Roslyn Analyzer Formatting Productivity CodeAnalysis C# CSharp</tags>
     <developmentDependency>true</developmentDependency>
-    <repository type="git" url="https://github.com/JosefPihrt/Roslynator.git" />
+    <repository type="git" url="https://github.com/josefpihrt/roslynator.git" />
+    <readme>docs\README.md</readme>
   </metadata>
   <files>
     <file src="bin\$Configuration$\netstandard2.0\Roslynator*.dll" target="analyzers\dotnet\cs" />
     <file src="tools\*.ps1" target="tools\" />
     <file src="..\..\images\icon.png" target="" />
+    <file src="docs\NuGetReadme.md" target="docs\README.md" />
   </files>
 </package>