Skip to content

Commit c59b50e

Browse files
Fixing linting issues in top level README
1 parent 1bf4c5f commit c59b50e

1 file changed

Lines changed: 18 additions & 19 deletions

File tree

README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Selenium [![Travis Status](https://travis-ci.com/SeleniumHQ/selenium.svg?branch=trunk)](https://travis-ci.com/SeleniumHQ/selenium/builds) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/pg1f99p1aetp9mk9/branch/trunk?svg=true)](https://ci.appveyor.com/project/SeleniumHQ/selenium/branch/trunk)
2-
========
1+
# Selenium [![Travis Status](https://travis-ci.com/SeleniumHQ/selenium.svg?branch=trunk)](https://travis-ci.com/SeleniumHQ/selenium/builds) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/pg1f99p1aetp9mk9/branch/trunk?svg=true)](https://ci.appveyor.com/project/SeleniumHQ/selenium/branch/trunk)
2+
33
<a href="https://selenium.dev"><img src="https://selenium.dev/images/selenium_logo_square_green.png" width="180" alt="Selenium"/></a>
44

55
Selenium is an umbrella project encapsulating a variety of tools and
@@ -39,17 +39,17 @@ which wraps the main build too, `bazel`.
3939

4040
### Bazel
4141

42-
[Bazel](https://bazel.build/) was built by the fine folks at Google. Bazel manages dependency
42+
[Bazel](https://bazel.build/) was built by the fine folks at Google. Bazel manages dependency
4343
downloads, generates the Selenium binaries, executes tests and does it all rather quickly.
4444

4545
More detailed instructions for getting Bazel running are below, but if you can successfully get
46-
the java and javascript folders to build without errors, you should be confident that you have the
46+
the java and javascript folders to build without errors, you should be confident that you have the
4747
correct binaries on your system.
4848

4949
### Before Building
5050

5151
Ensure that you have Chrome installed and the
52-
[`chromedriver` ](https://chromedriver.chromium.org/downloads) that matches
52+
[`chromedriver`](https://chromedriver.chromium.org/downloads) that matches
5353
your Chrome version available on your `$PATH`. You may have to update this from time to time.
5454

5555
### Common Build Targets
@@ -71,14 +71,14 @@ bazel build java/... javascript/...
7171
If you're making changes to the java/ or javascript/ folders in this project, and this command
7272
executes without errors, you should be able to create a PR of your changes. (See also CONTRIBUTING.md)
7373

74-
### Build Details ###
74+
### Build Details
7575

76-
- Bazel files are called BUILD.bazel
77-
- [crazyfun](https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build) build files are called
76+
* Bazel files are called BUILD.bazel
77+
* [crazyfun](https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build) build files are called
7878
*build.desc*. This is an older build system, still in use in the project
79-
- There is also a main Rakefile
79+
* There is also a main Rakefile
8080

81-
The order the modules are built is determined by the build system. If you want to build an
81+
The order the modules are built is determined by the build system. If you want to build an
8282
individual module (assuming all dependent modules have previously been built), try the following:
8383

8484
```sh
@@ -102,7 +102,7 @@ To list all available targets, you can append the `-T` flag:
102102
## Requirements
103103

104104
* The latest version of the [Java 11 OpenJDK](https://openjdk.java.net/)
105-
* `java` and `jar` on the PATH (make sure you use `java` executable from JDK but not JRE).
105+
* `java` and `jar` on the PATH (make sure you use `java` executable from JDK but not JRE).
106106
* To test this, try running the command `javac`. This command won't exist if you only have the JRE
107107
installed. If you're met with a list of command-line options, you're referencing the JDK properly.
108108
* [Bazel](https://docs.bazel.build/versions/master/install.html)
@@ -140,7 +140,7 @@ skipped silently if you are not building on Windows.
140140

141141
## Common Tasks (Bazel)
142142

143-
To build the bulk of the Selenium binaries from source, run the
143+
To build the bulk of the Selenium binaries from source, run the
144144
following command from the root folder:
145145

146146
```sh
@@ -219,7 +219,7 @@ going. Java test outputs appear in one of two places: either under
219219
tests. If you'd like the build to be chattier, just append `log=true`
220220
to the build command line.
221221

222-
# Help with `go`
222+
## Help with `go`
223223

224224
More general, but basic, help for `go`
225225

@@ -235,7 +235,7 @@ targets.
235235
## Maven _per se_
236236

237237
If it is not clear already, Selenium is not built with Maven. It is
238-
built with `bazel`, though that is invoked with `go` as outlined above,
238+
built with `bazel`, though that is invoked with `go` as outlined above,
239239
so you do not really have to learn too much about that.
240240

241241
That said, it is possible to relatively quickly build Selenium pieces
@@ -261,7 +261,7 @@ wiki page for the last word on building the bits and pieces of Selenium.
261261

262262
### MacOS
263263

264-
#### bazelisk
264+
#### bazelisk
265265

266266
Bazelisk is a Mac-friendly launcher for Bazel. To install, follow these steps:
267267

@@ -276,22 +276,21 @@ brew install bazelbuild/tap/bazelisk
276276
If you're getting errors that mention Xcode, you'll need to install the command-line tools.
277277

278278
Bazel for Mac requires some additional steps to configure properly. First things first: use
279-
the Bazelisk project (courtesy of philwo), a pure golang implementation of Bazel. In order to
279+
the Bazelisk project (courtesy of philwo), a pure golang implementation of Bazel. In order to
280280
install Bazelisk, first verify that your Xcode will cooperate: execute the following command:
281281

282282
`xcode-select -p`
283283

284284
If the value is `/Applications/Xcode.app/Contents/Developer/`, you can proceed with bazelisk
285285
installation. If, however, the return value is `/Library/Developer/CommandLineTools/`, you'll
286-
need to redirect the Xcode system to the correct value.
286+
need to redirect the Xcode system to the correct value.
287287

288288
```
289289
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer/
290290
sudo xcodebuild -license
291291
```
292292

293-
The first command will prompt you for a password. The second step requires you to read a new Xcode
293+
The first command will prompt you for a password. The second step requires you to read a new Xcode
294294
license, and then accept it by typing "agree".
295295

296296
(Thanks to [this thread](https://github.com/bazelbuild/bazel/issues/4314) for these steps)
297-

0 commit comments

Comments
 (0)