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

Add README to NuGet packages #674

Open
3 tasks
kurtschelfthout opened this issue Mar 3, 2024 · 0 comments
Open
3 tasks

Add README to NuGet packages #674

kurtschelfthout opened this issue Mar 3, 2024 · 0 comments

Comments

@kurtschelfthout
Copy link
Member

Low priority.

Nuget.org is highlighting that they expect a README for the package. Seems relatively easy:

https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/#add-a-readme-to-your-package

There is already a description, so I don't think the top-level README.md in this repo is appropriate to include.

For the main FsCheck package, I'd instead extract https://fscheck.github.io/FsCheck//QuickStart.html#A-Simple-Example to a file, check it in and include that with the nuget package. It's ok if that is a manual step, though I guess bonus points for doing it automatically somehow (that would mean we don't have to maintain the same doc multiple times!)

For the others perhaps something similar (a small usage example) can be put together/extracted from the existing docs.

  • Add Nuget readme for FsCheck
  • Add Nuget readme for FsCheck.Xunit
  • Add Nuget readme for FsCheck.NUnit
@kurtschelfthout kurtschelfthout changed the title NuGet package could use a README Add README to NuGet packages Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant