Skip to content

docs: Update README.md with WinAppDriver Notice[Rel/5.x] #624

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 8, 2023
Merged

docs: Update README.md with WinAppDriver Notice[Rel/5.x] #624

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Build Status](https://dev.azure.com/AppiumCI/dotnet-client/_apis/build/status/appium.appium-dotnet-driver?branchName=master)](https://dev.azure.com/AppiumCI/dotnet-client/_build/latest?definitionId=13&branchName=master)

This driver is an extension of the [Selenium](http://docs.seleniumhq.org/) C# client. It has
all the functionalities of the regular driver, but add Appium specific methods on top of this.
all the functionalities of the regular driver, but add Appium-specific methods on top of this.

## Appium server compatibility for v5.x

Expand All @@ -15,6 +15,13 @@ In case you are using the latest beta client v5.x please be aware you will eithe
Regardless, it's highly recommended you move to appium 2.x since appium 1.x is no longer maintained. <br/>
For more details about how to migrate to 2.x, see the following link : [appium 2.x migrating](https://appium.github.io/appium/docs/en/2.0/guides/migrating-1-to-2/)

## WinAppDriver Notice!

Due to the fact that [WinAppDriver](https://github.com/microsoft/WinAppDriver) has been abandoned by MS, running Appium dotnet-client 5.x with WAD will not work since it has not been updated to support the W3C protocol. <br/>
In order to run appium on Windows Applications, you will need to use [appium-windows-driver](https://github.com/appium/appium-windows-driver) which will basically act as a proxy to WAD.
Examples of running Windows Applications with dotnet-client can be found here: [windows Integration test 5.0.0](https://github.com/appium/dotnet-client/tree/release/5.0.0/test/integration/Windows) <br/>
Regardless, feel free to open an issue on the [WAD](https://github.com/microsoft/WinAppDriver/issues) repository that will help get MS to open-source that project.

## NuGet

NuGet Package: [](http://www.nuget.org/packages/Appium.WebDriver/)
Expand Down Expand Up @@ -54,7 +61,7 @@ JetBrains Rider
- From the menu `Build -> Rebuild Solution`
- Run tests in Appium.Net.Integration.Tests

Visual studio
Visual Studio

- Open with [Visual Studio](https://www.visualstudio.com/)
- build solution
Expand All @@ -68,7 +75,7 @@ Visual studio


### To Release a New Version
- update assemblyInfo.cs, RELEASE_NOTES.md, and appium-dotnet-driver.nuspec with new new version number and release details, then check it in
- update assemblyInfo.cs, RELEASE_NOTES.md, and appium-dotnet-driver.nuspec with the new version number and release details, then check it in
- pull new code
- `Rebuild All` with `Release` target.
- `NuGet pack appium-dotnet-driver.nuspec`
Expand Down