Skip to content

Split library and package Readme #78888

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

Merged
ViktorHofer merged 11 commits into from
Dec 12, 2022
Merged

Split library and package Readme #78888

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a9d577f
Split library and package Readme
MSDN-WhiteKnight Nov 27, 2022
944daa0
Fix punctuation
MSDN-WhiteKnight Nov 27, 2022
170adeb
Fix lint issues
MSDN-WhiteKnight Nov 27, 2022
fc32b96
Automatically include package readme file if existent
ViktorHofer Nov 28, 2022
1f95da5
Rename README.md to PACKAGE.md
ViktorHofer Nov 28, 2022
1b0a89e
Move PACKAGE.md into source directory
ViktorHofer Nov 28, 2022
ea477be
Reinstate examples in README.md
MSDN-WhiteKnight Nov 28, 2022
053003e
Merge remote-tracking branch 'upstream/main' into package-readme
MSDN-WhiteKnight Nov 29, 2022
f091280
Merge branch 'main' into package-readme
ViktorHofer Dec 6, 2022
368609c
Update contributing guidelines
MSDN-WhiteKnight Dec 8, 2022
af34dcf
Update docs/coding-guidelines/libraries-packaging.md
ViktorHofer Dec 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update docs/coding-guidelines/libraries-packaging.md
  • Loading branch information
@ViktorHofer
ViktorHofer authored Dec 12, 2022
commit af34dcf738665d75218d6529e656297176ee48fc
2 changes: 1 addition & 1 deletion docs/coding-guidelines/libraries-packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Packages can include a Markdown Readme file with a short usage documentation. To
The package Readme is displayed on the package details page on [NuGet gallery](https://nuget.org/). You can include the following content in it:

- A description of the package purpose.
- Information when package should be used. For example, if the library is included in the shared framework in .NET, but needs to be isntalled via NuGet in .NET Framework, it should be mentioned.
- Information when package should be used. For example, if the library is included in the shared framework in .NET, but needs to be installed via NuGet on .NET Framework, it should be mentioned.
- Information on how to get started with the package.
- Links to related documentation.
- A list of common entry-point types for the package, with links to their API docs under [.NET API Browser](https://learn.microsoft.com/dotnet/api/).
Expand Down