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 NuGet package READMEs #7291

Merged
merged 2 commits into from
Jan 25, 2022
Merged

Add NuGet package READMEs #7291

merged 2 commits into from
Jan 25, 2022

Conversation

rainersigwald
Copy link
Member

This should improve understandablity of our packages.
@rainersigwald rainersigwald added Area: Our Own Build Problems affecting the build or build infrastructure of the MSBuild repo itself. Area: API labels Jan 13, 2022
@rainersigwald rainersigwald added this to the VS 17.2 milestone Jan 13, 2022
Copy link
Member

@baronfel baronfel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for doing this :) I built locally with ./build.cmd -pack and verified the packages via nuget.info, so this is all set from my perspective.

@@ -1,27 +1,29 @@
<Project>

<PropertyGroup>
<PackageReadmeFile>README.md</PackageReadmeFile>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this trick, I do it on all of my multi-package projects :D

@baronfel
Copy link
Member

After this PR, should this doc still exist?

@rainersigwald
Copy link
Member Author

After this PR, should this doc still exist?

Hm, I think having the pointers to the packages still makes sense but it can be streamlined. I'm also going to steal some of that text for the new READMEs 🤦🏻

redistribute the MSBuild runtime to evaluate or build MSBuild projects within their application. This can be necessary because prior to MSBuild version 15, MSBuild was installed globally on a machine and universally
available to all applications. However, in MSBuild version 15 and forward, MSBuild is redistributed by each application that uses it and applications are unable to share other instances.

This package delivers a complete executable copy of MSBuild. Reference this
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I'd ever heard of this 😮

@Forgind Forgind added the merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now. label Jan 15, 2022
@ladipro ladipro merged commit 750b4f2 into dotnet:main Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: API Area: Our Own Build Problems affecting the build or build infrastructure of the MSBuild repo itself. merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add readmes to NuGet packages
4 participants