Skip to content

Commit 86dbcf5

Browse files
committed
README: clean up build instructions
1 parent b82e4d7 commit 86dbcf5

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,37 +25,40 @@ and generally make it more difficult to read our changelists.
2525

2626
## Building
2727

28-
Selenium uses a custom build system called
28+
Selenium uses a custom build system aptly named
2929
[crazyfun](https://github.com/SeleniumHQ/selenium/wiki/CrazyFunBuild)
3030
available on all fine platforms (Linux, Mac, Windows). We are in the
3131
process of replacing this with
3232
[buck](http://facebook.github.io/buck/), so don't be alarmed if you
3333
see some directories carrying multiple build directive files.
34-
crazyfun's build files are called *build.desc*, while buck's are named
35-
simply *BUCK*.
34+
crazyfun's build files are named *build.desc*,
35+
while buck's are named simply *BUCK*.
3636

37-
To build Selenium, in the same directory as this file, do…
37+
To build Selenium, in the same directory as this file:
3838

3939
```sh
4040
./go
4141
```
4242

43-
The order of building modules is determined by the `go` system itself.
44-
If you want to build an individual module (assuming all dependent
45-
modules have previously been built) try something like:
43+
The order of building modules is determined by the build system.
44+
If you want to build an individual module
45+
(assuming all dependent modules have previously been built)
46+
try something like:
4647

4748
```sh
4849
./go //javascript/atoms:test:run
4950
```
5051

51-
In this case, `javascript/atoms` is the module directory, and `test` is a target
52-
in that directory's `build.desc` file.
52+
In this case, `javascript/atoms` is the module directory,
53+
`test` is a target in that directory's `build.desc` file,
54+
and `run` is the action to run on that target.
5355

54-
As you see *build targets* scroll past in the log, you may want to run
55-
them individually. `go` can run them individually, by target name as
56-
long as `:run` is appended (see above).
56+
As you see *build targets* scroll past in the log,
57+
you may want to run them individually.
58+
crazyfun can run them individually,
59+
by target name as long as `:run` is appended (see above).
5760

58-
To list all available targets, you can append `-T` as an option:
61+
To list all available targets, you can append the `-T` flag:
5962

6063
```sh
6164
./go -T
@@ -67,15 +70,15 @@ Although the plan is to return to a vanilla build of Buck as soon as
6770
possible, we currently use a fork, hosted at
6871
https://github.com/shs96c/buck To build using Buck, first clone that
6972
repo and build using ant. Then add Buck's "bin" directory to your
70-
PATH. Once that's done...
73+
PATH.
7174

72-
Obtain a list of all available targets
75+
To obtain a list of all available targets:
7376

7477
```sh
7578
buck targets
7679
```
7780

78-
Build a particular file:
81+
And build a particular file:
7982

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

0 commit comments

Comments
 (0)