首先得明确一个核心限制：NuGet客户端（包括Visual Studio的包管理器和dotnet CLI）仅会在安装包含readme.txt的包时自动弹出打开该文件。你配置的<PackageReadmeFile>属性是用来在NuGet源（比如你的私有源）的包详情页面展示README内容的，并不是触发安装后自动打开的机制——这就是为什么readme.txt能正常弹出，而readme.md不行的原因。

下面给你两种可行的解决方案：

方案一：兼容自动打开 + 保留MD格式的详情展示（推荐） #

这个方案兼顾了自动弹出提示和MD格式的可读性，具体做法是同时打包readme.txt和readme.md：

1. 在项目根目录创建一个readme.txt，内容可以简单引导用户查看MD文件，比如：

   欢迎使用本NuGet包！
   请查看包根目录下的readme.md获取详细使用说明。
   

2. 修改你的.csproj配置，同时包含两个文件的打包配置：

   <PropertyGroup> 
     <TargetFramework>netcoreapp3.0</TargetFramework> 
     <PackageReadmeFile>readme.md</PackageReadmeFile> 
     <IsPackable>true</IsPackable> 
   </PropertyGroup> 
   <ItemGroup> 
     <!-- 打包readme.md到包根，用于源页面展示 -->
     <None Include="readme.md" Pack="true" PackagePath="." />
     <!-- 打包readme.txt到包根，触发安装后自动打开 -->
     <None Include="readme.txt" Pack="true" PackagePath="." />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.1" /> 
   </ItemGroup>
   

3. 重新打包并推送你的NuGet包到私有源，之后其他项目安装时就会自动弹出readme.txt，用户可以根据提示查看更详细的MD文档。

方案二：使用NuGet安装脚本打开MD文件（进阶，有局限性） #

如果你不想用txt文件，可以通过NuGet的PowerShell安装脚本来实现，但需要注意：

• 仅支持使用Package Manager Console安装包的场景，dotnet CLI安装不会触发
• 依赖用户系统有能打开MD文件的程序（比如VS Code、Markdown Viewer等）
• Visual Studio可能会限制脚本执行权限

具体步骤：

1. 在项目根目录创建tools文件夹，里面添加install.ps1脚本，内容如下：

   param($installPath, $toolsPath, $package, $project)
   # 获取readme.md的路径
   $readmePath = Join-Path $installPath "readme.md"
   # 尝试用默认程序打开MD文件
   if (Test-Path $readmePath) {
       Start-Process $readmePath
   }
   

2. 修改.csproj，把脚本打包到NuGet的tools目录：

   <ItemGroup>
     <None Include="tools\install.ps1" Pack="true" PackagePath="tools" />
     <!-- 保留原来的readme.md打包配置 -->
     <None Include="readme.md" Pack="true" PackagePath="." />
     <PackageReadmeFile>readme.md</PackageReadmeFile>
     <!-- 其他配置... -->
   </ItemGroup>
   

这种方法虽然能直接打开MD文件，但兼容性不如方案一，所以更推荐第一种方案。

内容的提问来源于stack exchange，提问作者Joe Pauly