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

Update Microsoft.Windows.Compatibility README.md #3835

Merged
merged 3 commits into from
Sep 2, 2023

Conversation

KlausLoeffelmann
Copy link
Member

No description provided.

@KlausLoeffelmann KlausLoeffelmann changed the title Update README.md Update Microsoft.Windows.Compatibility README.md Sep 1, 2023
src/Microsoft.Windows.Compatibility/src/README.md Outdated Show resolved Hide resolved
src/Microsoft.Windows.Compatibility/src/README.md Outdated Show resolved Hide resolved
src/Microsoft.Windows.Compatibility/src/README.md Outdated Show resolved Hide resolved
## Feedback

We value your feedback! Here are ways to get in touch with us:
Copy link
Member

Choose a reason for hiding this comment

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

This is a nice phrase, we can use it in the System.Drawing.Common readme too!

src/Microsoft.Windows.Compatibility/src/README.md Outdated Show resolved Hide resolved
src/Microsoft.Windows.Compatibility/src/README.md Outdated Show resolved Hide resolved
@Tanya-Solyanik
Copy link
Member

You will cherry-pick this change to release/8.0 branch, right?

@KlausLoeffelmann KlausLoeffelmann merged commit 8e46d3b into main Sep 2, 2023
@KlausLoeffelmann KlausLoeffelmann deleted the KlausLoeffelmann-ReadmePatch branch September 2, 2023 01:24
Comment on lines +9 to +23
```
Install-Package Microsoft.Windows.Compatibility -Version [your_version_here]
```

### .NET CLI
```
dotnet add package Microsoft.Windows.Compatibility --version [your_version_here]
```

### Prerequisites

- .NET Core 2.0+
- .NET 5+
- .NET Standard 2.0 or higher
Copy link
Member

Choose a reason for hiding this comment

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

Please remove these three sections. These are already part of the UI of nuget.org and tooling:

image

Copy link
Member Author

Choose a reason for hiding this comment

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

That would then also count for System.Drawing.Common, I suppose, which did not have a readme, either?

Copy link
Member

Choose a reason for hiding this comment

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

Did you already add a package readme for System.Drawing.Common? Yes, probably applies to that library as well.

@ViktorHofer
Copy link
Member

ViktorHofer commented Sep 2, 2023

@KlausLoeffelmann you accidentally updated the repo documentation for the Microsoft.Windows.Compatibility package which targets devs that need to update the library in this repository.

Instead, the package readme should be named PACKAGE.md and the original README.md should be kept. Please see dotnet/runtime#91210 for an example of the PACKAGE.md and its format.

In addition, your changes don't take effect unless you add this infrastructure:

  1. https://github.com/dotnet/runtime/blob/ba041aa0ff6d80a382f67db5ba1cec3a8ade5def/eng/packaging.targets#L22
  2. https://github.com/dotnet/runtime/blob/ba041aa0ff6d80a382f67db5ba1cec3a8ade5def/eng/packaging.targets#L70-L73

You can set that directly in the Microsoft.Windows.Compatibility.csproj project file.

@KlausLoeffelmann
Copy link
Member Author

KlausLoeffelmann commented Sep 5, 2023

Ah, shoot. OK, I am fixing that right now.
Will apply probably for the System.Drawing.Common package, either.

The latter I did already in that one.

KlausLoeffelmann added a commit that referenced this pull request Sep 7, 2023
* Update README.md

* Update Code-Tic-Formatting in README.md

* Address review feedback.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants