Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include README on publish #237

Closed
TheAngryByrd opened this issue May 20, 2021 · 1 comment · Fixed by #242
Closed

Include README on publish #237

TheAngryByrd opened this issue May 20, 2021 · 1 comment · Fixed by #242
Labels
enhancement An addition/change to an existing feature

Comments

@TheAngryByrd
Copy link
Owner

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 TheAngryByrd added Feature Completely new functionality enhancement An addition/change to an existing feature and removed Feature Completely new functionality labels May 20, 2021
@TheAngryByrd TheAngryByrd mentioned this issue May 28, 2021
2 tasks
@TheAngryByrd
Copy link
Owner Author

Since this requires 5.0.300, this will be blocked from really working until fsprojects/FAKE#2597 is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An addition/change to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant