geckodriver: readme: add note about webdriver crate

Source-Repo: https://github.com/mozilla/geckodriver
Source-Revision: 06249a7b3785b41ec8bd49059b1d6127a894a047

committer: David Burns <david.burns@theautomatedtester.co.uk>

--HG--
extra : rebase_source : a32ee539d53556392e5dca4a823a2072fadd09f6
This commit is contained in:
Andreas Tolfsen 2017-04-19 21:55:20 +01:00
parent d7a2448b69
commit f2f7acb743

View File

@ -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/