Skip to content

Commit

Permalink
Fixing linting issues in top level README
Browse files Browse the repository at this point in the history
  • Loading branch information
AutomatedTester committed Aug 21, 2020
1 parent 1bf4c5f commit c59b50e
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
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)
========
# 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)

<a href="https://selenium.dev"><img src="https://selenium.dev/images/selenium_logo_square_green.png" width="180" alt="Selenium"/></a>

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

### Bazel

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

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

### Before Building

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

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

### Build Details ###
### Build Details

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

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

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

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

## Common Tasks (Bazel)

To build the bulk of the Selenium binaries from source, run the
To build the bulk of the Selenium binaries from source, run the
following command from the root folder:

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

# Help with `go`
## Help with `go`

More general, but basic, help for `go`

Expand All @@ -235,7 +235,7 @@ targets.
## Maven _per se_

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

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

### MacOS

#### bazelisk
#### bazelisk

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

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

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

`xcode-select -p`

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

```
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer/
sudo xcodebuild -license
```

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

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

0 comments on commit c59b50e

Please sign in to comment.