Skip to content

Commit

Permalink
Update developer guide
Browse files Browse the repository at this point in the history
Fix instructions for installing local builds
  • Loading branch information
John Luo committed Jul 14, 2020
1 parent c60541b commit 5ebf8f3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ while [[ -h $source ]]; do
done

scriptroot="$( cd -P "$( dirname "$source" )" && pwd )"
"$scriptroot/eng/common/build.sh" --pack --build --restore $@
"$scriptroot/eng/common/build.sh" --build --restore $@
22 changes: 19 additions & 3 deletions docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,26 @@ On macOS/Linux:

## Using local builds

The easiest way to use a custom build of tye is to `dotnet run -p <path to tye projet>`.
The easiest way to use a custom build of tye is to `dotnet run -p <path to tye projet>`.

If you want to install your build as a dotnet global tool, that is possible as well. Building the repo will create packages in the artifacts folder that can be used.
If you want to install your build as a dotnet global tool, that is possible as well with the following steps:

1. Building the repo and create packages in the artifacts folder that can be used

On Windows:

```ps1
.\build.cmd -pack
```

On macOS/Linux:

```bash
./build.sh --pack
```

2. Install the package

```sh
dotnet install tye -g --version "0.1.0-dev" --add-source ./artifacts/packages/Debug/Shipping
dotnet tool install microsoft.tye -g --version "0.4.0-dev" --add-source ./artifacts/packages/Debug/Shipping
```

0 comments on commit 5ebf8f3

Please sign in to comment.