Skip to content

Commit

Permalink
Tweak confusing directions for Tye installations. (dotnet#1221)
Browse files Browse the repository at this point in the history
  • Loading branch information
philliphoff authored Nov 19, 2021
1 parent 9b1a817 commit cb6fc57
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Tye is a tool that makes developing, testing, and deploying microservices and di

## Installing Tye

1. Install [.NET 6](<https://dot.net>).
1. Install [.NET Core 3.1](<https://dot.net>).

> .NET Core 3.1 is required for the current release of Tye (`0.10.0`). Going forward, both recent CI builds as well as future releases of Tye will require .NET 6.
1. Install tye via the following command:

```text
Expand All @@ -17,6 +20,14 @@ Tye is a tool that makes developing, testing, and deploying microservices and di
dotnet tool update -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
```
> If using Mac with both `arm64` and `x64` .NET SDKs, you may need to supply the `-a x64` parameter when installing Tye as it requires the x64 version of .NET Core 3.1.
>
> Example:
>
> ```
> dotnet tool install -a x64 -g Microsoft.Tye --version "0.10.0-alpha.21420.1"
> ```
> If using Mac and, if getting "command not found" errors when running `tye`, you may need to ensure that the `$HOME/.dotnet/tools` directory has been added to `PATH`.
>
> For example, add the following to the end of your `~/.zshrc` or `~/.zprofile`:
Expand Down

0 comments on commit cb6fc57

Please sign in to comment.