Browse Source

Update developer guide

Fix instructions for installing local builds
pull/579/head
John Luo 6 years ago
parent
commit
5ebf8f391b
  1. 2
      build.sh
  2. 22
      docs/developer_guide.md

2
build.sh

@ -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
docs/developer_guide.md

@ -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
```
Loading…
Cancel
Save