Iin .NET Core and .NET Standard projects content or tools distributed as part of a NuGet package are no longer installed. However there is one (hidden?) feature that still works and that is to show a readme file. Let’s see how to get this done:
- Add a readme.txt file to the project that you package through nuget.
- Open the .csproj filed and add the following entry:
This file contains 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
<ItemGroup> | |
<None Include="readme.txt" pack="true" PackagePath="." /> | |
<ItemGroup> |
This will embed a readme.txt file in the root folder of the package. When the package is restored, the file gets displayed by Visual Studio: