Use root README in nuget #567
Conversation
Charles-Gagnon
requested review from
MaddyDev,
chlafreniere and
lucyzhang929
as code owners
| <None Include="pkgicon.png" Pack="true" PackagePath="" /> | ||
| <None Include="..\lib\Microsoft.SqlServer.TransactSql.ScriptDom.dll" Pack="true" PackagePath="lib/$(TargetFramework)" /> | ||
| <None Include=".\README.md" Pack="true" PackagePath="" /> | ||
| <None Include="..\README.md" Pack="true" PackagePath="" /> |
There was a problem hiding this comment.
Won't relative links in the root README be broken if a user tries to access them from nuget.org?
There was a problem hiding this comment.
Oh hey good catch, yeah let me update them to be fully qualified
There was a problem hiding this comment.
It's almost like I have experience with markdown links or something 😅
There was a problem hiding this comment.
It's not quite as nice since now :
- It always links to main (so if you have a specific branch with changes you wanted to test or whatever the links would go to the wrong place)
- If editing in VS Code it'll open up in your external web browser instead of in VS Code itself
Neither of these are huge issues - just minor things during development. So I'm fine with making this since the alternative is to keep two copies of the README (which makes keeping them in sync annoying) or write some custom script to replace the relative values before packaging. Both of which seem like more work than is necessary.
Use root README in nuget
Closes #162