From 590d39a17d00445ea3112380aa65bda0f71262e1 Mon Sep 17 00:00:00 2001 From: sebv Date: Tue, 1 Jul 2014 20:30:01 +0800 Subject: [PATCH] doc fixes --- README.md | 6 ++++-- docs/en/hybrid.md | 2 +- docs/en/intro.md | 3 ++- docs/en/running-on-linux.md | 2 +- docs/en/running-tests.md | 6 ++++-- docs/en/troubleshooting.md | 3 ++- 6 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2a158ad83..d1d412cc2 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ See the [platform support doc](docs/en/platform-support.md) for more detailed in to use of standard automation APIs on all platforms. 2. You can write tests with your favorite dev tools using any [WebDriver](https://code.google.com/p/selenium/wiki/JsonWireProtocol)-compatible language such as Java, [Objective-C](https://github.com/appium/selenium-objective-c), - JavaScript with Node.js (in both [callback](https://github.com/admc/wd) and [yield-based](https://github.com/jlipps/yiewd) flavors), + JavaScript with Node.js (in [promise, callback](https://github.com/admc/wd) or [generator](https://github.com/jlipps/yiewd) flavors), PHP, Python, [Ruby](https://github.com/appium/ruby_lib), C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries. 3. You can use any testing framework. @@ -48,7 +48,9 @@ Your environment needs to be setup for the particular mobile platforms that you want to run tests on. See below for particular platform requirements. If you want to run Appium via an `npm install`, hack with or contribute to Appium, you will need -[node.js and npm](http://nodejs.org) 0.10 or greater (`brew install node`: make sure you have not installed Node or Appium with `sudo`, otherwise you'll run into problems). We recommend the latest stable version. +[node.js and npm](http://nodejs.org) 0.10 or greater (use [n](https://github.com/visionmedia/n) or +`brew install node` to install Node.js. Make sure you have not installed Node or Appium with `sudo`, +otherwise you'll run into problems). We recommend the latest stable version. To verify that all of Appium's dependencies are met you can use `appium-doctor`. Run `appium-doctor` and supply the `--ios` or `--android` flags to verify that all diff --git a/docs/en/hybrid.md b/docs/en/hybrid.md index 9370defe0..df4ea1c4e 100644 --- a/docs/en/hybrid.md +++ b/docs/en/hybrid.md @@ -30,7 +30,7 @@ Here are the steps required to talk to a web view in your Appium test: ## Execution against a real iOS device -To interrogate and interact with a web view appium establishes a connection +To interact with a web view appium establishes a connection using a remote debugger. When executing the examples below against a simulator this connection can be established directly as the simulator and the appium server are on the same machine. When executing against a real diff --git a/docs/en/intro.md b/docs/en/intro.md index 9437b7e31..1f11829d3 100644 --- a/docs/en/intro.md +++ b/docs/en/intro.md @@ -72,7 +72,8 @@ connections from a client, listens for commands, executes those commands on a mobile device, and responds with an HTTP response representing the result of the command execution. The fact that we have a client/server architecture opens up a lot of possibilities: we can write our test code in any language -that has a client. We can put the server on a different machine than our +that has a http client API, but it is easier to use one of the Appium client +library. We can put the server on a different machine than our tests are running on. We can write test code and rely on a cloud service like [Sauce Labs](https://saucelabs.com/mobile) to receive and interpret the commands. diff --git a/docs/en/running-on-linux.md b/docs/en/running-on-linux.md index 685bd5a98..8a7948234 100644 --- a/docs/en/running-on-linux.md +++ b/docs/en/running-on-linux.md @@ -8,7 +8,7 @@ apps because Appium relies on OS X-only libraries to support iOS testing. ## Setup -To get started, you'll need to install node.js (v.0.8 or greater). Just +To get started, you'll need to install node.js (v.0.10 or greater). Just follow the [instructions for your flavor of linux](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager). Once you've got node.js installed, install the [Android SDK](http://developer.android.com/sdk/index.html). diff --git a/docs/en/running-tests.md b/docs/en/running-tests.md index 1344acd7f..4778d9d66 100644 --- a/docs/en/running-tests.md +++ b/docs/en/running-tests.md @@ -73,7 +73,8 @@ capabilities.setCapability("app", myApp); In this set of capabilities, `myApp` must be either: * A local absolute path to your simulator-compiled .app directory or .zip -* A url of a zip file containg your .app package +* A url of a zip file containing your .app package +* A path to one of the sample app relative to the appium install root Using your WebDriver library of choice, set the remote session to use these capabilities and connect to the server running at port 4723 of localhost (or @@ -148,7 +149,8 @@ capabilities.setCapability("app", myApp); In this set of capabilities, `myApp` must be either: * A local absolute path to your .apk or a .zip of it -* A url of a zip file containg your .apk +* A url of a zip file containing your .apk +* A path to one of the sample app relative to the appium install root Using your WebDriver library of choice, set the remote session to use these capabilities and connect to the server running at port 4723 of localhost (or diff --git a/docs/en/troubleshooting.md b/docs/en/troubleshooting.md index 53b329634..d58fd8cfd 100644 --- a/docs/en/troubleshooting.md +++ b/docs/en/troubleshooting.md @@ -96,7 +96,8 @@ output when it's run in verbose mode so that we can diagnose what's going on. ## Known Issues * If you've installed Node from the Node website, it requires that you use sudo - for `npm`. This is not ideal. Try to get node with `brew install node` instead! + for `npm`. This is not ideal. Try to get node with + [n](https://github.com/visionmedia/n) or `brew install node` instead! * Webview support works on real iOS devices with a proxy, see [discussion](https://groups.google.com/d/msg/appium-discuss/u1ropm4OEbY/uJ3y422a5_kJ). * Sometimes iOS UI elements become invalidated milliseconds after they are found. This results in an error that looks like `(null) cannot be tapped`.