Skip to content

Commit 0eff7fc

Browse files
prezaeiPedram Rezaei
andauthored
Add dedicated NuGet package README (#4)
* Fix README rendering on NuGet * Add dedicated NuGet package documentation --------- Co-authored-by: Pedram Rezaei <pedram@lab.tailb6364e.ts.net>
1 parent c4771dc commit 0eff7fc

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

‎PACKAGE_README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Cloudtoid.CodeAnalysis
2+
3+
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.
4+
5+
## Install
6+
7+
Requires a project targeting .NET 10 or later.
8+
9+
```sh
10+
dotnet add package Cloudtoid.CodeAnalysis
11+
```
12+
13+
For a library, keep this build-time dependency private by adding `PrivateAssets="all"` to its `PackageReference`.
14+
15+
## What it configures
16+
17+
- Installs StyleCop and Visual Studio threading analyzers.
18+
- Imports the Cloudtoid ruleset and StyleCop configuration during builds.
19+
- Enables warnings as errors.
20+
21+
Build your project after installation to see diagnostics. Review the rules before adopting the package in an existing codebase: warnings can become build failures.
22+
23+
[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)

‎src/Cloudtoid.CodeAnalysis.csproj‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<!-- NuGet Packaging -->
88
<PropertyGroup>
9-
<PackageReadmeFile>README.md</PackageReadmeFile>
9+
<PackageReadmeFile>PACKAGE_README.md</PackageReadmeFile>
1010
<PackageId>Cloudtoid.CodeAnalysis</PackageId>
1111
<Title>Cloudtoid.CodeAnalysis</Title>
1212
<Authors>pedram@rezaei.us</Authors>
@@ -37,7 +37,7 @@
3737
</ItemGroup>
3838

3939
<ItemGroup>
40-
<None Include="../README.md" Pack="true" PackagePath="/" />
40+
<None Include="../PACKAGE_README.md" Pack="true" PackagePath="/" />
4141
</ItemGroup>
4242

4343
</Project>

0 commit comments

Comments
 (0)