Skip to content

Commit

Permalink
.net tool: clarify install instructions
Browse files Browse the repository at this point in the history
Because we use dotnet publish (which requires a specific framework) to
create the payload of our .NET tool package, the package is tied to the
framework specified. This means that it will only work with the
corresponding .NET SDK for that framework.

In light of this, update the .NET tool install instructions to specify
that users must download the latest .NET 6.0 SDK as a prerequisite for
installing the package, since that is the framework for which we
currently publish. This will also need to be updated whenever we upgrade
to a new Target Framework.

Additionally, remove Windows as a supported .NET tool platform. Since we
currently target .NET Framework rather than .NET, the package cannot
actually be installed on Windows.
  • Loading branch information
ldennington committed Feb 23, 2023
1 parent cf4b3e9 commit 8b2b9df
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,11 @@ tool][dotnet-tool]. This is
the preferred install method for Linux because you can use it to install on any
[.NET-supported
distribution][dotnet-supported-distributions]. You
can also use this method on macOS or Windows if you so choose.
can also use this method on macOS if you so choose.

**Note:** Make sure you have installed .NET before attempting to run the
following `dotnet tool` commands.
**Note:** Make sure you have installed the [latest version of the .NET 6.0
SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) before attempting
to run the following `dotnet tool` commands.

#### Install

Expand Down

0 comments on commit 8b2b9df

Please sign in to comment.