From d2619eb78bb4e5b72c86e214a120fb898a08ea65 Mon Sep 17 00:00:00 2001
From: Yann Sionneau <ys@m-labs.hk>
Date: Mon, 9 Feb 2015 12:27:36 +0100
Subject: [PATCH] Add documentation about ARTIQ_GUI environment variable

Also adds "python-gi" as Ubuntu dependency as this is needed
for the GUI.
---
 doc/manual/installing.rst | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst
index cf24433e2..70a78fe6d 100644
--- a/doc/manual/installing.rst
+++ b/doc/manual/installing.rst
@@ -149,12 +149,31 @@ Installing the host-side software
 .. note::
     Compilation of LLVM can take more than 30 min on some machines.
 
-* Install ARTIQ: ::
+* Install ARTIQ (without the GUI): ::
 
         $ cd ~/artiq-dev
         $ git clone https://github.com/m-labs/artiq # if not already done
+        $ cd artiq
         $ python3 setup.py develop --user
 
+* Install ARTIQ (with the GUI): ::
+
+        $ cd ~/artiq-dev
+        $ git clone https://github.com/m-labs/cairoplot3
+        $ cd cairoplot3
+        $ python3 setup.py install --user
+        $ cd -
+        $ git clone https://github.com/m-labs/gbulb
+        $ cd gbulb
+        $ python3 setup.py install --user
+        $ cd -
+        $ git clone https://github.com/m-labs/artiq # if not already done
+        $ cd artiq
+        $ ARTIQ_GUI=1 python3 setup.py develop --user
+
+.. note::
+    Use ARTIQ_GUI=1 to install GUI dependencies which are only supported on Linux for now, to install ARTIQ on Windows do not set ARTIQ_GUI.
+
 * Build the documentation: ::
 
         $ cd ~/artiq-dev/artiq/doc/manual
@@ -165,7 +184,7 @@ Xubuntu 14.04 specific instructions
 
 This command installs all the required packages: ::
 
-    $ sudo apt-get install build-essential autotools-dev file git patch perl xutils-devs python3-pip texinfo flex bison libmpc-dev python3-serial python3-dateutil python3-prettytable python3-setuptools python3-numpy python3-scipy python3-sphinx python3-h5py python3-dev python-dev subversion cmake libusb-dev libftdi-dev pkg-config
+    $ sudo apt-get install build-essential autotools-dev file git patch perl xutils-devs python3-pip texinfo flex bison libmpc-dev python3-serial python3-dateutil python3-prettytable python3-setuptools python3-numpy python3-scipy python3-sphinx python3-h5py python3-gi python3-dev python-dev subversion cmake libusb-dev libftdi-dev pkg-config
 
 Note that ARTIQ requires Python 3.4 or above.