Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mozilla/geckodriver.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Tolfsen <ato@mozilla.com>2017-04-10 19:18:54 +0300
committerDavid Burns <david.burns@theautomatedtester.co.uk>2017-04-19 23:55:20 +0300
commit06249a7b3785b41ec8bd49059b1d6127a894a047 (patch)
tree87966828b8916563bb976a76945a9350e808fb1d
parent44d47f2751c125cfc27be38c62453e56e2893aad (diff)
readme: add note about webdriver crate
-rw-r--r--README.md23
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md
index f9b870c..0aa6534 100644
--- a/README.md
+++ b/README.md
@@ -504,10 +504,14 @@ This is analogous to passing `--log debug` and `--log trace`, respectively.
## Building
-geckodriver is written in [Rust](https://www.rust-lang.org/),
-a systems programming language from [Mozilla](https://www.mozilla.org/en-US/).
-In order to build this program,
-you will need the [Rust compiler toolchain](https://rustup.rs/).
+geckodriver is written in [Rust], a systems programming language from [Mozilla].
+Crucially, it relies on the [webdriver crate] to provide the HTTPD
+and do most of the heavy lifting of marshalling the WebDriver protocol.
+geckodriver translates WebDriver [commands], [responses], and [errors]
+to the [Marionette protocol],
+and acts as a proxy between [WebDriver] and [Marionette].
+
+In order to build this program, you will need the [Rust compiler toolchain].
To build the project for release,
ensure you compile with optimisations
@@ -518,3 +522,14 @@ to get the best performance:
Or if you want a non-optimised binary for debugging:
% cargo build
+
+[Rust]: https://www.rust-lang.org/
+[Mozilla]: https://www.mozilla.org/en-US/
+[webdriver crate]: https://github.com/mozilla/webdriver-rust
+[commands]: https://docs.rs/webdriver/0.25.0/webdriver/command/index.html
+[responses]: https://docs.rs/webdriver/0.25.0/webdriver/response/index.html
+[errors]: https://docs.rs/webdriver/0.25.0/webdriver/error/enum.ErrorStatus.html
+[Marionette protocol]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Protocol
+[WebDriver]: https://w3c.github.io/webdriver/webdriver-spec.html
+[Marionette]: http://searchfox.org/mozilla-central/source/testing/marionette/README
+[Rust compiler toolchain]: https://rustup.rs/