Skip to content

Commit

Permalink
Add some usage info to README (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
drewnoakes authored and jeffkl committed Jul 16, 2019
1 parent 913832f commit 67541e2
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Expand Up @@ -29,7 +29,32 @@ Supports utility projects that do not compile an assembly.

Supports staging artifacts from build outputs.

## What Are MSBuild SDKS?
## How can I use these SDKs?

When using an MSBuild Project SDK obtained via NuGet (such as the SDKs in this repo) a specific version **must** be specified.

Either append the version to the package name:

```xml
<Project Sdk="Microsoft.Build.Traversal/2.0.12">
...
```

Or omit the version from the SDK attribute and specify it in the version in `global.json`, which can be useful to synchronise versions across multiple projects in a solution:

```json
{
"msbuild-sdks": {
"Microsoft.Build.Traversal" : "2.0.12"
}
}
```

Since MSBuild 15.6, SDKs are downloaded as NuGet packages automatically. Earlier versions of MSBuild 15 required SDKs to be installed.

This comment has been minimized.

Copy link
@msfcolombo

msfcolombo Apr 30, 2021

This doesn't appear to be working. Please see dotnet/msbuild#6391


For more information, [read the documentation](https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk).

## What are MSBuild SDKS?
MSBuild 15.0 introduced new project XML for .NET Core that we refer to as SDK-style. These SDK-style projects looks like:

```xml
Expand All @@ -54,10 +79,6 @@ At evaluation time, MSBuild adds implicit imports at the top and bottom of the p
</Project>
```

More documentation is available [here](https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk).

Older versions of MSBuild 15 required that SDKs be installed prior to using them. In MSBuild 15.6 and above, the SDKs are downloaded as NuGet packages instead.

# Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down

0 comments on commit 67541e2

Please sign in to comment.