Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add README.md to NuGet package #1598

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.

Sign up for GitHub

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

Jump to bottom
Closed
lostmsu opened this issue Oct 15, 2021 · 0 comments
Closed

Add README.md to NuGet package #1598

lostmsu opened this issue Oct 15, 2021 · 0 comments

Comments

@lostmsu
Copy link
Member

lostmsu commented Oct 15, 2021

NuGet.org now shows README.md file if you include it into the package.

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

Problem is our README is in .rst format. The options are:

  1. new README.md tailored to .NET
  2. rewrite our .rst into .md

I prefer option 1 because our README has info for both embedding into Python and into .NET, but NuGet package is tailored only for embedding into .NET.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@filmor @lostmsu