diff --git a/PACKAGE_README.md b/PACKAGE_README.md new file mode 100644 index 0000000..4942462 --- /dev/null +++ b/PACKAGE_README.md @@ -0,0 +1,23 @@ +# Cloudtoid.CodeAnalysis + +Shared C# analyzer configuration for projects that use Cloudtoid's coding conventions. The package brings together StyleCop and Visual Studio threading analyzers with a common ruleset and build settings. + +## Install + +Requires a project targeting .NET 10 or later. + +```sh +dotnet add package Cloudtoid.CodeAnalysis +``` + +For a library, keep this build-time dependency private by adding `PrivateAssets="all"` to its `PackageReference`. + +## What it configures + +- Installs StyleCop and Visual Studio threading analyzers. +- Imports the Cloudtoid ruleset and StyleCop configuration during builds. +- Enables warnings as errors. + +Build your project after installation to see diagnostics. Review the rules before adopting the package in an existing codebase: warnings can become build failures. + +[Source and rules](https://github.com/cloudtoid/code-analysis) · [Report an issue](https://github.com/cloudtoid/code-analysis/issues) · [MIT license](https://github.com/cloudtoid/code-analysis/blob/main/LICENSE) diff --git a/src/Cloudtoid.CodeAnalysis.csproj b/src/Cloudtoid.CodeAnalysis.csproj index 4d1396b..7401237 100644 --- a/src/Cloudtoid.CodeAnalysis.csproj +++ b/src/Cloudtoid.CodeAnalysis.csproj @@ -6,7 +6,7 @@ - README.md + PACKAGE_README.md Cloudtoid.CodeAnalysis Cloudtoid.CodeAnalysis pedram@rezaei.us @@ -37,7 +37,7 @@ - +