summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2013-12-09 09:58:08 +0100
committerRiitta-Leena Miettinen <riitta-leena.miettinen@digia.com>2013-12-09 12:12:17 +0200
commitf4e22adea13f4d9b0fbbe1c407aacb9d5584dd97 (patch)
tree1b067c43bd988ce77052bc6726d542f3cb951aa9 /src
parent62e3601a82c60cfa41c3b7b6981c3f6bdca7d546 (diff)
Doc: edit the installation instructions
Remove excessive formatting as it reduces readability. Use numbered lists to describe processes. Use active voice instead of passive voice. Edit for grammar and style. Change-Id: I1e5f9636c57898ea09633167e022a3195a2967d6 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/doc/src/b2qt-post-install-setup.qdocinc55
-rw-r--r--src/doc/src/b2qt.qdoc76
2 files changed, 69 insertions, 62 deletions
diff --git a/src/doc/src/b2qt-post-install-setup.qdocinc b/src/doc/src/b2qt-post-install-setup.qdocinc
index c4fe4a2..d1a6f08 100644
--- a/src/doc/src/b2qt-post-install-setup.qdocinc
+++ b/src/doc/src/b2qt-post-install-setup.qdocinc
@@ -18,54 +18,57 @@
****************************************************************************/
/*!
//! [setting up usb access]
- On Ubuntu Linux you have to grant your development user access to
- plugged in devices. This is done by creating a new \e{udev} rule
- that allows access to the device via USB. First, run the following
- command in a shell:
+ On Ubuntu Linux, the development user account must have access to plugged in
+ devices. To allow the development user access to the device via USB, create
+ a new \e{udev} rule:
+
+ \list 1
+
+ \li Run the following command in a shell:
\code
echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="18d1", TAG+="udev-acl"' | sudo tee -a /etc/udev/rules.d/70-boot2qt.rules
\endcode
- Now connect the running device to the development host with a USB
- cable. (If already connected, disconnect and reconnect the USB
- cable after running the command above).
+ \li Connect the running device to the development host with a USB
+ cable. If the device is already connected, disconnect and reconnect the USB
+ cable after running the command above.
- On \B2QA, you can confirm that the connection is working by running
- this shell command:
+ \li On \B2QA, you can confirm that the connection is working by running
+ the following shell command:
\code
<INSTALL_DIR>/Tools/b2qt/adb devices
\endcode
- The output should be a list of connected android devices,
- identified with a serial number and a name. Note that the emulator
- may be listed as well, its serial number will be its IP and port
- number (\c{192.168.56.101:5555}). If your device is missing from
+ The output should be a list of connected Android devices,
+ identified with a serial number and a name. If your device is missing from
the list, or the serial number is \c{??????}, the connection is
- not working properly. If so, check that the device is powered up,
- and that the USB cable has been disconnected and reconnected.
+ not working properly. Check that the device is powered up, and disconnect
+ and reconnect the USB cable.
+
+ The emulator may be listed as well. Its serial number is its IP and the port
+ number: \c{192.168.56.101:5555}.
+ \endlist
The system log files \c{/var/log/udev} and \c{/var/log/syslog} may
provide relevant information in case of connection problems.
//! [setting up usb access]
//! [configuring device kit]
- After the hardware has been prepared, there is one final step required
- to set up the development tools in Qt Creator for your device.
-
- You have to configure the right device to be used for each \b{Kit}.
-
- To do so, connect your device to your computer via USB and launch
- Qt Creator. Then,
+ After you have prepared the hardware, you must perform one final step
+ to set up the development tools in Qt Creator for your device. That is,
+ you must configure the correct device to be used for each build and run
+ \e{kit}. Connect your device to the development host via USB and launch
+ Qt Creator. In Qt Creator:
//! [steps for device kit]
\list 1
- \li Go to \b{Tools > Options > Build & Run > Kits}
- \li Select one of the predefined Kits starting with \e{Boot2Qt...}
+ \li Select \b{Tools > Options > Build & Run > Kits}.
+ \li Select one of the predefined kits starting with \e{Boot2Qt...}
that matches the type of your device.
- \li Select the correct device in the \b{Device} combobox.
- \li Click \b{Ok}.
+ \li Select the correct device in the \b{Device} field.
+ \li Select \b{OK}.
\endlist
//! [steps for device kit]
//! [configuring device kit]
diff --git a/src/doc/src/b2qt.qdoc b/src/doc/src/b2qt.qdoc
index 378f092..f682f13 100644
--- a/src/doc/src/b2qt.qdoc
+++ b/src/doc/src/b2qt.qdoc
@@ -158,14 +158,15 @@
\previouspage qtee-overview.html
\nextpage qtee-supported-platforms.html
- \e{IMPORTANT: \SDK requires the following installation steps to be followed closely.}
+ To successfully set up \SDK, you must closely follow the instructions in
+ this section and perform all the described tasks.
In case of problems, see the \l{Troubleshooting} information and the
- Known Issues in Qt Enterprise Embedded product page in Digia customer
+ \e {Known Issues} on the Qt Enterprise Embedded product page in the Digia customer
portal.
\target Requirements for Development Host
- \section1 0. Requirements for Development Host
+ \section1 Requirements for Development Host
A 64-bit Linux system is required to install and use \SDK. Instructions
in this documentation assume Ubuntu Linux 64-bit 12.04 LTS or later.
@@ -176,8 +177,8 @@
\section1 1. Installing 32-bit Support Libraries
Some of the build tools in \SDK are 32-bit programs, and on 64-bit
- systems they require that support libraries for running 32-bit
- code are present in the system. To install the required packages
+ systems they require support libraries for running 32-bit code. To install
+ the required packages
in Ubuntu, use the following command in a terminal:
\code
@@ -195,56 +196,60 @@
sudo apt-get install virtualbox
\endcode
- \b{Configuring VirtualBox}
+ To configure VirtualBox:
- Open VirtualBox network settings: Select \b{File > Preferences...}
- and click on the \b{Network} tab. Create a new network named
- \e{vboxnet0} and edit its properties:
-
- \list
- \li Change IPv4 address to 192.168.56.1 and IPv4 network mask to 255.255.255.0.
- \li Check \b{Enable Server} in \b{DCHP Server} tab.
- \li Change server address to 192.168.56.1.
- \li Change both the lower and upper address bounds to 192.168.56.101.
+ \list 1
+ \li Start the VirtualBox user interface.
+ \li Select \b{File > Preferences} > \b{Network} to open VirtualBox
+ network settings.
+ \li Create a new network named \e{vboxnet0} and edit its properties:
+
+ \list 1
+ \li Change the IPv4 address to \c{192.168.56.1} and the IPv4 network
+ mask to \c{255.255.255.0}.
+ \li In the \b{DCHP Server} tab, select the \b{Enable Server} check
+ box.
+ \li Change the server address to \c{192.168.56.1}.
+ \li Change both the lower and upper address bounds to
+ \c{192.168.56.101}.
+ \endlist
\endlist
\section1 3. Installing \SDK
- If you have not already installed \SDK, do it as follows.
+ \list 1
- After downloading the binary installer, make sure it is executable either by
+ \li Download the binary \SDK installer, and make sure it is executable
+ by using one of the following methods:
\list
- \li Using \c{chmod +x <filename>} command, or
- \li Right-clicking on the file, selecting \b{Properties}, and checking
- \b{Allow executing file as program} on the \b{Permissions} tab.
+ \li Enter the \c{chmod +x <filename>} command.
+ \li Right-click the file, and select \b{Properties} >
+ \b{Permissions} > \b{Allow executing file as program}.
\endlist
- Run the installer and follow its instructions.
+ \li Run the installer and follow its instructions.
+
+ \endlist
The installer will let you select a directory where \SDK will be
- installed. In the rest of this documentation, that directory is referred
+ installed. In this documentation, the installation directory is referred
to as \b{\c{<INSTALL_DIR>}}. The default installation directory is
\tt{~/Qt}.
\target Installing Boot to Qt on Target Devices
\section1 4. Install \B2Q on Target Devices
- \e{If targeting only the emulator, this step may be skipped}
+ \e{If you target only the emulator, you can skip this step.}
- Before deploying and testing your Qt application on hardware, the
- target device needs to be flashed with an image that contains the
- \B2Q stack. These steps vary from device to device. See the
- following chapter and follow the instructions specific to
- your device.
-
- \list
- \li \l {Preparing Hardware}
- \endlist
+ Before you can deploy and test your Qt application on hardware, you must
+ flash the target device with an image that contains the
+ \B2Q stack. The steps vary from device to device. Follow the instructions
+ specific to your device in \l {Preparing Hardware}.
\section1 5. Setting up USB Access to Embedded Devices
- \e{If targeting only the emulator, this step may be skipped}
+ \e{If you target only the emulator, you can skip this step.}
\include b2qt-post-install-setup.qdocinc setting up usb access
@@ -252,9 +257,8 @@
\include b2qt-post-install-setup.qdocinc configuring device kit
- \b {You are now ready to start developing for your device!}
-
- See \l{Building and Running an Example}
+ You are now ready to start developing for your device.
+ For more information, see \l{Building and Running an Example}.
*/
/*!