From ef11b3cd90af0b1779d9b69e99bac3037bb7d4ce Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 11 Sep 2013 12:16:30 +0200 Subject: Doc: Improve flow of install/setup instructions Make it easier to follow the setup steps by eliminating the need for back-tracking and switching between docs. - Detach Setting up USB Access + QtC Kits into a separate qdoc file, which is included by each of the device-specific setup guides, making them endpoints for the installation guide. - Add Building and Running an Example as the last step for each device-specific guide. - Copy tar-ball installation commands from boundary devices website, making it possible to finish the setup with a single guide. - Move i.MX 6 'Upgrading the Bootloader' topic to Troubleshooting section - Update page titles, prev/next linking + other minor fixes Change-Id: Ic8eeadefd0b416598730e857421053934092dc05 Reviewed-by: Eirik Aavitsland --- src/doc/src/b2qt-post-install-setup.qdocinc | 52 +++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 src/doc/src/b2qt-post-install-setup.qdocinc (limited to 'src/doc/src/b2qt-post-install-setup.qdocinc') diff --git a/src/doc/src/b2qt-post-install-setup.qdocinc b/src/doc/src/b2qt-post-install-setup.qdocinc new file mode 100644 index 0000000..4733aa8 --- /dev/null +++ b/src/doc/src/b2qt-post-install-setup.qdocinc @@ -0,0 +1,52 @@ +/*! +//! [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: + + \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). + + On \B2QA, you can confirm that the connection is working by running + this shell command: + + \code + /targets/android-utils/bin/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 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. + + 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 (\B2Q IDE). Then, + + \list 1 + \li Go to \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}. + \endlist +//! [configuring device kit] +*/ -- cgit v1.2.3