TheAngryByrd / MiniScaffold

F# Template for creating and publishing libraries targeting .NET 6.0 `net6.0` or console apps .NET 6.0 `net6.0`.
https://www.jimmybyrd.me/MiniScaffold/
MIT License
267 stars 31 forks source link

Include README on publish #237

Closed TheAngryByrd closed 3 years ago

TheAngryByrd commented 3 years ago

Is your feature request related to a problem? Please describe.

As of 5.0.300, you can package your README.md in your nuget package.

Describe the solution you'd like

The suggested solution from the blog post:

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        ...
        <PackageReadmeFile>README.md</PackageReadmeFile>
        ...
    </PropertyGroup>

    <ItemGroup>
        ...
        <None Include="docs\README.md" Pack="true" PackagePath="\"/>
        ...
    </ItemGroup>
</Project>

Describe alternatives you've considered

n/a

Additional context

n/a

TheAngryByrd commented 3 years ago

Since this requires 5.0.300, this will be blocked from really working until https://github.com/fsharp/FAKE/pull/2597 is merged