Bug 1262181 - Update install section of Firefox Puppeteer documentation. r?maja_zf draft
authorHenrik Skupin <mail@hskupin.info>
Mon, 09 May 2016 13:12:14 +0200
changeset 364796 3794b314e70d5f0c4161da8077ba56b86935895e
parent 364787 e8256ae1b2672250240077ccdd6a97557b34526b
child 520390 f882c81a2dd3200593490633ee7e39a85eb1f525
push id17567
push userbmo:hskupin@gmail.com
push dateMon, 09 May 2016 11:15:34 +0000
reviewersmaja_zf
bugs1262181
milestone49.0a1
Bug 1262181 - Update install section of Firefox Puppeteer documentation. r?maja_zf MozReview-Commit-ID: 1SSS0HGGqFy
testing/puppeteer/firefox/docs/index.rst
--- a/testing/puppeteer/firefox/docs/index.rst
+++ b/testing/puppeteer/firefox/docs/index.rst
@@ -1,34 +1,41 @@
 .. py:currentmodule:: firefox_puppeteer
 
 Firefox Puppeteer
 =================
 
-Firefox Puppeteer is a library built on top of the `Marionette python client`_.
+`Firefox Puppeteer`_ is a library built on top of the `Marionette Python client`_.
 It aims to make automation of Firefox's browser UI simpler. It does **not**
 make sense to use Firefox Puppeteer if:
 
 * You are manipulating something other than Firefox (like Firefox OS)
 * You are only manipulating elements in content scope (like a webpage)
 
 Roughly speaking, Firefox Puppeteer provides a library to manipulate each
 visual section of Firefox's browser UI. For example, there are different
 libraries for the tab bar, the navigation bar, etc.
 
+.. _Firefox Puppeteer: http://firefox-puppeteer.readthedocs.io/
+.. _Marionette Python client: http://marionette-client.readthedocs.org/
 
 Installation
 ------------
 
-Currently Firefox Puppeteer lives in the `firefox-ui-tests`_ repository,
-along with instructions for installation and usage.
-There are plans to move it alongside the `Marionette python client`_.
+For end-users Firefox Puppeteer can be easily installed as a `Python package`_
+from PyPI. If you want to contribute to the project we propose that you clone
+the `mozilla-central`_ repository and run the following commands::
 
-.. _Marionette python client: http://marionette-client.readthedocs.org/en/latest/
-.. _firefox-ui-tests: https://github.com/mozilla/firefox-ui-tests/tree/mozilla-central/firefox_puppeteer
+$ cd testing/puppeteer/firefox
+$ python setup.py develop
+
+In both cases all necessary files including all dependencies will be installed.
+
+.. _Python package: https://pypi.python.org/pypi/firefox-puppeteer
+.. _mozilla-central: https://hg.mozilla.org/mozilla-central
 
 
 Libraries
 ---------
 
 The following libraries are currently implemented. More will be added in the
 future. Each library is available from an instance of the FirefoxTestCase class.