Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme.md for dotnet-svcutil. #4756

Merged
merged 1 commit into from
Nov 3, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add readme.md for dotnet-svcutil.
  • Loading branch information
imcarolwang committed Oct 27, 2021
commit 809be9a4c92c1bc1ff950b1211c7241dea56e3f4
30 changes: 30 additions & 0 deletions src/dotnet-svcutil/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# dotnet-svcutil -- command-line tool for generating a web service reference compatible with .NET Core and .NET Standard projects.

## How to build

Execute following commandline under repository's root directory:
`eng\common\cibuild.cmd -preparemachine -configuration Release -projects dotnet-svcutil.sln /p:Test=false /p:Sign=false`

Alternatively, run `build.cmd` which located at same directory of this readme file.

The built package is placed at:
`[RepoRootDir]/artifacts/artifacts/packages/[Release/Debug]/[Shipping/NonShipping]/[dotnet-svcutil.*.nupkg]`

## How to run test

Execute following commandline under repository's root directory:
`eng\common\cibuild.cmd -preparemachine -configuration Release -projects dotnet-svcutil.sln /p:Test=True /p:Sign=false`

Test result summary could be found at:
`[RepoRootDir]/artifacts/artifacts/TestResults/[Release/Debug]/dotnet-svcutil-lib.Tests*.xml`

Test result details could be found at:
`[RepoRootDir]/artifacts/artifacts/TestOutput/TestResults/`, each test variation has a corresponding folder generated.

## How to install and uninstall the tool

Uninstall:
`dotnet tool uninstall --global dotnet-svcutil`

Install:
`dotnet tool install --global --add-source [RepoRootDir]/artifacts/packages/[Release/Debug]/[Shipping/NonShipping] dotnet-svcutil --version [tool-version]`