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.

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

Add ReadMe to NuGet packages #64342

Closed
clairernovotny opened this issue Jan 26, 2022 · 3 comments
Closed

Add ReadMe to NuGet packages #64342

clairernovotny opened this issue Jan 26, 2022 · 3 comments
Labels
area-Infrastructure-libraries

Comments

@clairernovotny
Copy link
Member

NuGet has supported displaying a ReadMe.md file contained in a package since last May. The .NET libraries should set an example and contain a ReadMe.md file in the packages. The readme would likely contain links to other resources we aleady have on getting started, support, etc.

See https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/ for details on how to add the ReadMe.md file to a package.

/cc @chgill-MSFT
@dotnet-issue-labeler dotnet-issue-labeler bot added area-Setup untriaged New issue has not been triaged by the area owner labels Jan 26, 2022
@madelson
Copy link
Contributor

This would be great so long as the content is package-specific and not just generic .net content/links.

@ghost
Copy link

ghost commented Jan 26, 2022

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

NuGet has supported displaying a ReadMe.md file contained in a package since last May. The .NET libraries should set an example and contain a ReadMe.md file in the packages. The readme would likely contain links to other resources we aleady have on getting started, support, etc.

See https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/ for details on how to add the ReadMe.md file to a package.

/cc @chgill-MSFT

Author: clairernovotny
Assignees: -
Labels:

area-Infrastructure-libraries, untriaged
Milestone: -

@carlossanlop
Copy link
Member

Duplicate of #59630

@carlossanlop carlossanlop marked this as a duplicate of #59630 Feb 3, 2022
@carlossanlop carlossanlop removed the untriaged New issue has not been triaged by the area owner label Feb 3, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Mar 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
area-Infrastructure-libraries
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@carlossanlop @madelson @clairernovotny @danmoseley