Skip to content

Commit

Permalink
Grammar and spacing fixes to README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Davison <daniel.jj.davison@gmail.com>
  • Loading branch information
jparry authored and ddavison committed Jul 28, 2015
1 parent 3dad4a8 commit d591944
Showing 1 changed file with 26 additions and 25 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Selenium

Selenium is an umbrella project for various tools and libraries that
enable automation of web browsers. Amongst other things it provides
the support infrastructure for the [W3C WebDriver
specification](https://dvcs.w3.org/hg/webdriver/raw-file/tip/webdriver-spec.html),
that lets you write interchangable code for all major web browsers.
Selenium is an umbrella project encapsulating a variety of tools and
libraries enabling web browser automation. Selenium specifically
provides infrastructure for the [W3C WebDriver specification](https://dvcs.w3.org/hg/webdriver/raw-file/tip/webdriver-spec.html)
— a platform and language-neutral coding interface compatible with all
major web browsers.

The project is made possible by volunteer contributors who have put in
thousands of hours of their own time, and made the source code freely
available under the [Apache 2.0
license](https://github.com/SeleniumHQ/selenium/blob/master/LICENSE).
The project is made possible by volunteer contributors who've
generously donated thousands of hours in code development and upkeep.

Selenium's source code is made available under the [Apache 2.0 license](https://github.com/SeleniumHQ/selenium/blob/master/LICENSE).

## Documentation

Expand All @@ -28,17 +28,18 @@ API documentation:

## Pull Requests

See [CONTRIBUTING.md](https://github.com/SeleniumHQ/selenium/blob/master/CONTRIBUTING.md).
Please read [CONTRIBUTING.md](https://github.com/SeleniumHQ/selenium/blob/master/CONTRIBUTING.md)
before submitting your pull requests.

## Building

Selenium uses a custom build system aptly named
[crazyfun](https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build)
available on all fine platforms (Linux, Mac, Windows). We are in the
process of replacing this with
process of replacing crazyfun with
[buck](http://facebook.github.io/buck/), so don't be alarmed if you
see some directories carrying multiple build directive files.
crazyfun's build files are named *build.desc*,
see directories carrying multiple build directive files.
For reference, crazyfun's build files are named *build.desc*,
while buck's are named simply *BUCK*.

To build Selenium, in the same directory as this file:
Expand All @@ -49,8 +50,8 @@ To build Selenium, in the same directory as this file:

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

```sh
./go //javascript/atoms:test:run
Expand All @@ -74,7 +75,7 @@ To list all available targets, you can append the `-T` flag:
### Buck

Although the plan is to return to a vanilla build of Buck as soon as
possible, we currently use a fork, hosted at
possible, we currently use a fork hosted at
https://github.com/shs96c/buck To build using Buck, first clone that
repo and build using ant. Then add Buck's "bin" directory to your
PATH.
Expand Down Expand Up @@ -134,13 +135,13 @@ you also need:
* [Visual Studio 2008](http://www.microsoft.com/visualstudio/en-gb/products/2008-editions)
* 32 and 64 bit cross compilers

The build will work on any platform, but the tests for IE will be skipped
silently, if you are not building on Windows.
The build will work on any platform, but the tests for IE will be
skipped silently, if you are not building on Windows.

## Common Tasks

For an express build of the binaries we release run the following from the
directory containing the `Rakefile`:
For an express build of the binaries we release run the following from
the directory containing the `Rakefile`:

```sh
./go clean release
Expand Down Expand Up @@ -285,9 +286,9 @@ targets.
## Maven _per se_

If it is not clear already, Selenium is not built with Maven, it is
built with [Crazy-Fun](https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build) though
that is invoked with *go* as outlined above so you do not really have
to learn too much about that.
built with [Crazy-Fun](https://github.com/SeleniumHQ/selenium/wiki/Crazy-Fun-Build)
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
for Maven to use. You are only really going to want to do this when
Expand All @@ -309,5 +310,5 @@ the name.
## Useful Resources

Refer to the [Building Web
Driver](https://github.com/SeleniumHQ/selenium/wiki/Building-WebDriver) wiki
page for the last word on building the bits and pieces of Selenium.
Driver](https://github.com/SeleniumHQ/selenium/wiki/Building-WebDriver)
wiki page for the last word on building the bits and pieces of Selenium.

0 comments on commit d591944

Please sign in to comment.