Skip to content

Conversation

@konard
Copy link
Member

@konard konard commented Sep 13, 2025

Summary

This PR implements the requirement to include README.md files in NuGet packages for both C# and C++ projects, as requested in issue #26.

Changes Made

  • C# Project: Added PackageReadmeFile property and included README.md file using MSBuild ItemGroup in Platform.Delegates.csproj
  • C++ Project: Added <readme> element in metadata and <files> section to include README.md in Platform.Delegates.TemplateLibrary.nuspec

Implementation Details

  • Followed Microsoft's documentation for including README files in NuGet packages
  • Used relative paths to include the root README.md file in both packages
  • Verified that C# package builds successfully and includes README.md
  • Both implementations are compatible with NuGet 5.10.0+ requirements

Test Plan

  • C# package builds successfully with dotnet pack
  • README.md file is included in the generated .nupkg file
  • C++ nuspec file follows proper XML schema for readme inclusion
  • Verify packages display README on NuGet.org when published

🤖 Generated with Claude Code


Resolves #26

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #26
@konard konard self-assigned this Sep 13, 2025
- Add PackageReadmeFile property to C# project file
- Add readme element and files section to C++ nuspec file
- Both packages now include README.md in their package contents

Fixes #26

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Include readme file at NuGet package Include README.md file in NuGet packages Sep 13, 2025
@konard konard marked this pull request as ready for review September 13, 2025 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include readme file at NuGet package

2 participants