Skip to content

Commit be25191

Browse files
committed
Including instructions for using buck in the README
1 parent 264a42b commit be25191

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,42 @@ To list all available targets, you can append `-T` as an option:
7171
./go -T
7272
```
7373

74+
### Buck
75+
76+
Although the plan is to return to a vanilla build of Buck as soon as
77+
possible, we currently use a fork, hosted at
78+
https://github.com/shs96c/buck To build using Buck, first clone that
79+
repo and build using ant. Then add Buck's "bin" directory to your
80+
PATH. Once that's done...
81+
82+
Obtain a list of all available targets
83+
84+
```sh
85+
buck targets
86+
```
87+
88+
Build a particular file:
89+
90+
```sh
91+
buck build //java/client/src/org/openqa/selenium:webdriver-api
92+
```
93+
94+
There are aliases for commonly invoked targets in the `.buckconfig`
95+
file, and these aliases can be invoked directly:
96+
97+
```sh
98+
buck build htmlunit
99+
```
100+
101+
All buck output is stored under "buck-out", with the outputs of build
102+
rules in `buck-out/gen`.
103+
104+
If you are doing a number of incremental builds, then you may want to
105+
use `buckd`, which starts a long-lived buck process to watch outputs
106+
and input files. If you do this, consider using `watchman` too, since
107+
the Java 7 file watcher isn't terribly efficient. This can be cloned
108+
from https://github.com/facebook/watchman
109+
74110
## Requirements
75111

76112
* [Java 6 JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html)

0 commit comments

Comments
 (0)