Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit 2131c03

Browse files
committed
cleanup(docs): remove confusing library documentation and fix font sizes
1 parent f9a477b commit 2131c03

File tree

5 files changed

+9
-33
lines changed

5 files changed

+9
-33
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Protractor [![Build Status](https://travis-ci.org/angular/protractor.png?branch=master)](https://travis-ci.org/angular/protractor)
22
==========
33

4-
Protractor is an end-to-end test framework for [AngularJS](http://angularjs.org/) applications. Protractor is a Node.js program built on top of [WebDriverJS](https://code.google.com/p/selenium/wiki/WebDriverJs). Protractor runs tests against your application running in a real browser, interacting with it as a user would.
4+
Protractor is an end-to-end test framework for [AngularJS](http://angularjs.org/) applications. Protractor is a [Node.js](http://nodejs.org/) program built on top of [WebDriverJS](https://code.google.com/p/selenium/wiki/WebDriverJs). Protractor runs tests against your application running in a real browser, interacting with it as a user would.
55

66

77
Getting Started
@@ -13,10 +13,12 @@ To get set up and running quickly:
1313
- Work through the [Tutorial](https://github.com/angular/protractor/blob/master/docs/tutorial.md)
1414
- Take a look at the [Table of Contents](https://github.com/angular/protractor/blob/master/docs/toc.md)
1515

16+
Once you are familiar with the tutorial, you’re ready to move on. To modify your environment, see the Protractor Setup docs. To start writing tests, see the Protractor Tests docs.
17+
1618
To better understand how Protractor works with the Selenium WebDriver and Selenium Sever see the reference materials.
1719

1820

19-
For contributors
21+
For Contributors
2022
----------------
2123
Clone the github repository:
2224

docs/browser-setup.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ capabilities: {
4141

4242
You may need to install a separate binary to run another browser, such as IE or Android.
4343

44-
### Adding chrome-specific options
44+
Adding Chrome specific options
45+
------------------------------
4546

4647
Chrome options are nested in the `chromeOptions` object. A full list of options is at [the chromedriver site](https://sites.google.com/a/chromium.org/chromedriver/capabilities). For example, to show an FPS counter in the upper right, your configuration would look like this:
4748

@@ -355,15 +356,3 @@ capabilities: {
355356
'phantomjs.cli.args':['--logfile=PATH', '--loglevel=DEBUG']
356357
}
357358
```
358-
359-
Appendix A: Using with the Protractor Library
360-
---------------------------------------------
361-
362-
If you are not using the Protractor runner and you are setting up webdriver yourself, you will need to create a capabilities object and pass it in to the webdriver builder. The `webdriver.Capabilities` namespace offers some preset options. See [the webdriver capabilities source](https://code.google.com/p/selenium/source/browse/javascript/webdriver/capabilities.js).
363-
364-
```javascript
365-
driver = new webdriver.Builder().
366-
usingServer('http://localhost:4444/wd/hub').
367-
withCapabilities(webdriver.Capabilities.phantomjs()).
368-
build();
369-
```

docs/install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Getting Installed
33

44
Prerequisites
55
-------------
6-
Node.js
6+
7+
**Node.js**
78

89
Protractor is a Node.js program. To run Protractor, you will need to have Node.js installed. Check the version of node you have by running `node --version`. It should be greater than v0.10.0.
910

1011
Node.js comes with the Protractor npm package, which you can use to install Protractor.
1112

12-
JDK
13-
---
13+
**JDK**
1414

1515
To run the Selenium Server, you will need to have Java Development Kit (JDK) installed. Check this by running `java --version` from the command line.
1616

docs/library-only.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/toc.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,5 @@ Reference
1818
- [Configuration File Reference](/docs/referenceConf.js)
1919
- [Protractor API](/docs/api.md)
2020
- [Timeouts](/docs/timeouts.md)
21-
- [Using the Protractor Library](/docs/library-only.md)
2221
- [The WebDriver Control Flow](/docs/control-flow.md)
2322
- [FAQ](/docs/faq.md)

0 commit comments

Comments
 (0)