Add a package README for ClangSharpPInvokeGenerator#746
Merged
tannergooding merged 1 commit intoJul 13, 2026
Merged
Conversation
The NuGet package page previously fell back to the description with no usage guidance. Add a dedicated package README covering what the tool does, how to install and run it as a .NET tool, and where to find the full option list and docs, wired up via PackageReadmeFile. Fixes dotnet#686 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The NuGet package page for
ClangSharpPInvokeGeneratorpreviously fell back to the shared package description with no usage guidance. Add a dedicated package README covering what the tool does (generates C#/.NET P/Invoke bindings from C/C++ headers via libclang), how to install and run it as a .NET tool, minimal-f/-n/-oand response-file examples, and pointers to--help/-c helpand the repo docs. Wired up via<PackageReadmeFile>+ a packed<None Include="README.md" ... />(no priorPackageReadmeFilepattern existed in the repo, so this follows the standard NuGet convention).Content is verified against the root README and the actual CLI options; the full options table is intentionally not duplicated -- it links to the canonical repo docs instead.
dotnet restoreon the csproj succeeds.Fixes #686