Add readme to nuget #2282
Add readme to nuget #2282
Conversation
src/devices/Directory.Build.props
Outdated
| @@ -27,6 +27,7 @@ | |||
| </ItemGroup> | |||
| <ItemGroup> | |||
| <ProjectReference Include="$(MainLibraryPath)System.Device.Gpio.csproj" /> | |||
| <Content Include="$(RepoRoot)src/device/README-nuget.md" Pack="true" PackagePath="\README.md" /> | |||
There was a problem hiding this comment.
I think this is not enough. This will make it so that the README itself is in the package, but it won't set the right things in the nuspec so that it shows up in NuGet.org or Visual Studio. For that, we should also set PackageReadmeFile. It is also tipically suggested to not use content item for things that do not go into content/ folder in the package, so we should probably use None instead. Here is the blog post where the NuGet team announced how to add Readme files to packages: https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/
There was a problem hiding this comment.
So, I adjusted everything, a checked the presence in the nuspec, can't really check the very final element but I think it should be ok according to the test I've been doing on a personal project.
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Microsoft Reviewers: Open in CodeFlow