Skip to content

Commit

Permalink
Fixing build process documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
barancev committed Jan 30, 2018
1 parent ef15606 commit 8409c1b
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,27 +82,27 @@ To list all available targets, you can append the `-T` flag:

Although the plan is to return to a vanilla build of Buck as soon as
possible, we currently use a fork hosted at
https://github.com/SeleniumHQ/buck To build using Buck, first clone that
repo and build using ant. Then add Buck's "bin" directory to your
PATH.
https://github.com/SeleniumHQ/buck

Selenium uses `buckw` wrapper utility that automatically downloads buck if necessary and runs it with the specified options.

To obtain a list of all available targets:

```sh
buck targets
buckw targets
```

And build a particular file:

```sh
buck build //java/client/src/org/openqa/selenium:webdriver-api
buckw build //java/client/src/org/openqa/selenium:webdriver-api
```

There are aliases for commonly invoked targets in the `.buckconfig`
file, and these aliases can be invoked directly:

```sh
buck build htmlunit
buckw build htmlunit
```

All buck output is stored under "buck-out", with the outputs of build
Expand All @@ -118,6 +118,8 @@ from https://github.com/facebook/watchman

* [Java 8 JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* `java` and `jar` on the PATH (make sure you use `java` executable from JDK but not JRE)
* [Python 2.7](https://www.python.org/)
* `python` on the PATH (make sure it's Python 2.7, as buck build tool is not Python 3 compatible)

Although the build system is based on rake, it's **strongly advised**
to rely on the version of JRuby in `third_party/` that is invoked by
Expand All @@ -129,7 +131,7 @@ Note that all Selenium Java artifacts are **built with Java 8

### Optional Requirements

* Python 2.7, Python 3.4+ (without these, Python and Python3 tests will be skipped)
* Python 3.4+ (if you want to run Python tests for this version)
* Ruby 2.0

### Internet Explorer Driver
Expand Down Expand Up @@ -305,7 +307,7 @@ The maven jars should now be in your local `~/.m2/repository`. You can also publ
directly using Buck:

```sh
buck publish -r your-repo //java/client/src/org/openqa/selenium:selenium
buckw publish -r your-repo //java/client/src/org/openqa/selenium:selenium
```

This sequence will push some seven or so jars into your local Maven
Expand Down

0 comments on commit 8409c1b

Please sign in to comment.