Skip to content

Commit 6eb6027

Browse files
committed
Update browser & OS specific notes in README
1 parent abac425 commit 6eb6027

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Run Selenium tests more easily with automatic installation and updates for all s
1414
* [IEDriverServer](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver)
1515
* [msedgedriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
1616

17-
Works on macOS, Linux, Windows, and Windows Subsystem for Linux (WSL) v1.
17+
Works on macOS, Linux, Windows, and Windows Subsystem for Linux (WSL) v1 and v2. And do see the browser and OS specific
18+
notes at the bottom.
1819

1920
## Usage
2021

@@ -195,21 +196,7 @@ The logging level can be configured for debugging purpose:
195196
Webdrivers.logger.level = :DEBUG
196197
```
197198

198-
### WSLv1 support
199-
200-
While WSLv1 is not designed to run headful applications like Chrome, it can run exes; as such when found to be running
201-
in WSL, `webdrivers` will use the Windows `chromedriver.exe`.
202-
203-
It's recommended that you install the new PowerShell (PS7) to avoid [a known issue](https://github.com/microsoft/terminal/issues/367)
204-
with the console font being changed when calling the old PowerShell (PS5).
205-
206-
### WSLv2 support
207-
208-
Webdrivers will detect WSLv2 as running on Linux.
209-
210-
WSLv2 doesn't support connecting to host ports out of the box, so it isn't possible to connect to Chromedriver on Windows without extra configurations, see: https://github.com/microsoft/WSL/issues/4619. The simplest way to use Chromedriver with WSLv2 is to run Chrome headless on Linux.
211-
212-
### Browser Specific Notes
199+
### Browser & OS Specific Notes
213200

214201
#### Chrome/Chromium
215202

@@ -234,7 +221,7 @@ variable.
234221
This is also required if Google Chrome is not installed in its
235222
[default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
236223

237-
##### Heroku Users
224+
#### Chrome on Heroku
238225

239226
Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if you're using `heroku-buildpack-google-chrome`.
240227

@@ -246,6 +233,27 @@ section apply to this browser as well.
246233

247234
Please note that `msedgedriver` requires `selenium-webdriver` v4.
248235

236+
#### WSLv1 support
237+
238+
While WSLv1 is not designed to run headful applications like Chrome, it can run exes; as such when found to be running
239+
in WSL, `webdrivers` will use Chrome on the Windows filesystem.
240+
241+
It's recommended that you install the new PowerShell (PS7) to avoid [a known issue](https://github.com/microsoft/terminal/issues/367)
242+
with the console font being changed when calling the old PowerShell (PS5).
243+
244+
#### WSLv2 support
245+
246+
Webdrivers will detect WSLv2 as running on Linux and use Chrome on the Linux filesystem.
247+
248+
WSLv2 doesn't support connecting to host ports out of the box, so it isn't possible to connect to Chromedriver on
249+
Windows without extra configurations, see: https://github.com/microsoft/WSL/issues/4619. The simplest way to use
250+
Chromedriver with WSLv2 is to run Chrome headless on Linux.
251+
252+
#### Chrome and Edge on Apple M1 (`arm64`)
253+
254+
If you're switching from Intel to M1, you'll have to manually delete the existing Intel (`mac64`) driver before the
255+
M1 (`arm64`) build can be downloaded. Otherwise, you'll get an error: `Bad CPU type in executable - ~/.webdrivers/chromedriver (Errno::E086)`
256+
249257
## Wiki
250258

251259
Please see the [wiki](https://github.com/titusfortner/webdrivers/wiki)

0 commit comments

Comments
 (0)