Skip to content

chore: include README in NuGet package#3052

Open
fuguiKz wants to merge 1 commit intodotnet:masterfrom
fuguiKz:pack/nuget-readme
Open

chore: include README in NuGet package#3052
fuguiKz wants to merge 1 commit intodotnet:masterfrom
fuguiKz:pack/nuget-readme

Conversation

@fuguiKz
Copy link
Contributor

@fuguiKz fuguiKz commented Mar 18, 2026

Fixes #2519\n\nAdds NuGet package readme metadata and packs the repo root README.md into the BenchmarkDotNet NuGet package so NuGet.org can display it.\n\nValidation:\n- dotnet pack src/BenchmarkDotNet/BenchmarkDotNet.csproj -c Release\n- verified the produced .nuspec contains README.md and the .nupkg includes README.md

@fuguiKz
Copy link
Contributor Author

fuguiKz commented Mar 21, 2026

Rebased onto latest master (aa373df); CI is green across all jobs, including test-pack.\n\nThis PR simply reuses the repo root README.md as the package readme (per the preference mentioned in #2519). If you'd rather wait for additional postprocessing/README trimming before wiring it into the publishing pipeline, I'm happy to adjust the approach (or split it into a follow-up).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

benchmarkdotnet is missing NuGet package README file

2 participants