@@ -35,7 +35,7 @@ before submitting your pull requests.
35
35
36
36
## Building
37
37
38
- Selenium uses a custom build system aptly named
38
+ Selenium uses a custom build system, aptly named
39
39
[ crazyfun] ( https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build )
40
40
available on all fine platforms (Linux, Mac, Windows). We are in the
41
41
process of replacing crazyfun with
@@ -44,7 +44,7 @@ see directories carrying multiple build directive files.
44
44
For reference, crazyfun's build files are named * build.desc* ,
45
45
while buck's are named simply * BUCK* .
46
46
47
- Before building ensure that you have the
47
+ Before building, ensure that you have the
48
48
[ most recent ` chromedriver ` ] ( https://sites.google.com/a/chromium.org/chromedriver/downloads )
49
49
available on your ` $PATH ` . You may have to update this from time to time.
50
50
@@ -70,7 +70,7 @@ and `run` is the action to run on that target.
70
70
As you see * build targets* scroll past in the log,
71
71
you may want to run them individually.
72
72
crazyfun can run them individually,
73
- by target name as long as ` :run ` is appended (see above).
73
+ by target name, as long as ` :run ` is appended (see above).
74
74
75
75
To list all available targets, you can append the ` -T ` flag:
76
76
@@ -119,12 +119,12 @@ from https://github.com/facebook/watchman
119
119
* [ Java 8 JDK] ( http://www.oracle.com/technetwork/java/javase/downloads/index.html )
120
120
* ` java ` and ` jar ` on the PATH
121
121
122
- Although the build system is based on rake it's ** strongly advised**
122
+ Although the build system is based on rake, it's ** strongly advised**
123
123
to rely on the version of JRuby in ` third_party/ ` that is invoked by
124
124
` go ` . The only developer type who would want to deviate from this is
125
125
the “build maintainer” who's experimenting with a JRuby upgrade.
126
126
127
- Note that all Selenium Java artefacts are ** built with Java 8
127
+ Note that all Selenium Java artifacts are ** built with Java 8
128
128
(mandatory)** . Those _ will work with any Java >= 8_ .
129
129
130
130
### Optional Requirements
@@ -135,18 +135,18 @@ Note that all Selenium Java artefacts are **built with Java 8
135
135
### Internet Explorer Driver
136
136
137
137
If you plan to compile the
138
- [ IE driver] ( https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver )
138
+ [ IE driver] ( https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver ) ,
139
139
you also need:
140
140
141
141
* [ Visual Studio 2008] ( http://www.microsoft.com/visualstudio/en-gb/products/2008-editions )
142
142
* 32 and 64 bit cross compilers
143
143
144
144
The build will work on any platform, but the tests for IE will be
145
- skipped silently, if you are not building on Windows.
145
+ skipped silently if you are not building on Windows.
146
146
147
147
## Common Tasks
148
148
149
- For an express build of the binaries we release run the following from
149
+ For an express build of the binaries we release, run the following from
150
150
the directory containing the ` Rakefile ` :
151
151
152
152
``` sh
@@ -155,7 +155,7 @@ the directory containing the `Rakefile`:
155
155
156
156
All build output is placed under the ` build ` directory. The output can
157
157
be found under ` build/dist ` . If an error occurs while running this
158
- task complaining about a missing Albacore gem, the chances are you're
158
+ task complaining about a missing Albacore gem, chances are you're
159
159
using ` rvm ` . If this is the case, switch to the system ruby:
160
160
161
161
``` sh
@@ -195,14 +195,14 @@ If you are interested in a single language binding, try one of:
195
195
./go test_javascript
196
196
```
197
197
198
- To run all the tests just run:
198
+ To run all the tests, run:
199
199
200
200
``` sh
201
201
./go test
202
202
```
203
203
204
204
This will detect your OS and run all the tests that are known to be
205
- stable for every browser that's appropriate to use for all language
205
+ stable, for every browser that's appropriate to use, for all language
206
206
bindings. This can take a healthy amount of time to run.
207
207
208
208
To run the minimal logical Selenium build:
@@ -213,7 +213,7 @@ To run the minimal logical Selenium build:
213
213
214
214
As a side note, ** none of the developers** run tests using
215
215
[ Cygwin] ( http://www.cygwin.com/ ) . It is very unlikely that the build
216
- will work as expected if you try and use it.
216
+ will work as expected if you try to use it.
217
217
218
218
## Tour
219
219
@@ -226,17 +226,17 @@ start the development server:
226
226
./go debug-server
227
227
```
228
228
229
- Now navigate to
229
+ Now, navigate to
230
230
[ http://localhost:2310/javascript ] ( http://localhost:2310/javascript ) .
231
231
You'll find the contents of the ` javascript/ ` directory being shown.
232
232
We use the [ Closure
233
233
Library] ( https://developers.google.com/closure/library/ ) for
234
- developing much of the javascript , so now navigate to
234
+ developing much of the JavaScript , so now navigate to
235
235
[ http://localhost:2310/javascript/atoms/test ] ( http://localhost:2310/javascript/atoms/test ) .
236
236
237
237
The tests in this directory are normal HTML files with names ending
238
238
with ` _test.html ` . Click on one to load the page and run the test. You
239
- can run all the javascript tests using:
239
+ can run all the JavaScript tests using:
240
240
241
241
``` sh
242
242
./go test_javascript
@@ -270,38 +270,38 @@ going. Java test outputs appear in one of two places: either under
270
270
tests. If you'd like the build to be chattier, just append ` log=true `
271
271
to the build command line.
272
272
273
- # Help with * go *
273
+ # Help with ` go `
274
274
275
- More general, but basic, help for * go * …
275
+ More general, but basic, help for ` go ` …
276
276
277
277
``` sh
278
278
./go --help
279
279
```
280
280
281
- Remember, * go * is just a wrapper around
281
+ ` go ` is just a wrapper around
282
282
[ Rake] ( http://rake.rubyforge.org/ ) , so you can use the standard
283
283
commands such as ` rake -T ` to get more information about available
284
284
targets.
285
285
286
286
## Maven _ per se_
287
287
288
- If it is not clear already, Selenium is not built with Maven, it is
288
+ If it is not clear already, Selenium is not built with Maven. It is
289
289
built with [ Buck] ( https://github.com/SeleniumHQ/buck ) ,
290
- though that is invoked with * go * as outlined above so you do not really
290
+ though that is invoked with ` go ` as outlined above, so you do not really
291
291
have to learn too much about that.
292
292
293
- That said, it is possible to relatively quickly build selenium pieces
293
+ That said, it is possible to relatively quickly build Selenium pieces
294
294
for Maven to use. You are only really going to want to do this when
295
295
you are testing the cutting-edge of Selenium development (which we
296
296
welcome) against your application. Here is the quickest way to build
297
- and deploy into you local maven repository (` ~/.m2/repository ` ), while
297
+ and deploy into your local maven repository (` ~/.m2/repository ` ), while
298
298
skipping Selenium's own tests.
299
299
300
300
``` sh
301
301
./go maven-install
302
302
```
303
303
304
- The maven jars should now be in your local ~ /.m2/repository. You can also publish
304
+ The maven jars should now be in your local ` ~/.m2/repository ` . You can also publish
305
305
directly using Buck:
306
306
307
307
``` sh
0 commit comments