diff --git a/docs/getting_started.md b/docs/getting_started.md index 6a31531e..8c4ce6e3 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -4,7 +4,10 @@ Tye is a tool that makes developing, testing, and deploying microservices and di ## Installing Tye -1. Install [.NET 6](). +1. Install [.NET Core 3.1](). + + > .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 @@ -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`: