summaryrefslogtreecommitdiffstats
path: root/src/doc/src/devices/qtee-beagleboard-xm.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-06-30 11:37:43 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2014-08-29 10:52:44 +0300
commit5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b (patch)
tree8ae9a2bf9f20cd353245a40e37fe6801fe0cff14 /src/doc/src/devices/qtee-beagleboard-xm.qdoc
parent5a3e8d73b675a90cd6c48b94c0b226148857fa9f (diff)
Doc: split up the docs into multiple files
Split up the monolithic b2qt.qdoc into separate documentation files, making future edits and maintenance easier. Device-specific instructions are created in devices/ subdirectory, and shared documentation (referenced in multiple places) are moved to shared/. Change-Id: I9425297781a1dda9c08a149b0870a0389c575560 Reviewed-by: Samuli Piippo <samuli.piippo@digia.com> Reviewed-by: Kalle Viironen <kalle.viironen@digia.com>
Diffstat (limited to 'src/doc/src/devices/qtee-beagleboard-xm.qdoc')
-rw-r--r--src/doc/src/devices/qtee-beagleboard-xm.qdoc69
1 files changed, 69 insertions, 0 deletions
diff --git a/src/doc/src/devices/qtee-beagleboard-xm.qdoc b/src/doc/src/devices/qtee-beagleboard-xm.qdoc
new file mode 100644
index 0000000..fae5725
--- /dev/null
+++ b/src/doc/src/devices/qtee-beagleboard-xm.qdoc
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use the contact form at
+** http://qt.digia.com/
+**
+** This file is part of Qt Enterprise Embedded.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** the contact form at http://qt.digia.com/
+**
+****************************************************************************/
+/*!
+ \target BeagleBoard-xM (embedded Linux)
+ \page qtee-preparing-hardware-beagleboard.html
+ \title Preparing BeagleBoard-xM
+ \previouspage qtee-installation-guide.html
+ \nextpage qtee-building-and-running.html
+
+ Take the following steps to prepare a \l{http://beagleboard.org/hardware-xM}
+ {BeagleBoard-xM} for
+ \B2Q.
+
+ \note BeagleBoard-xM is no longer supported in \SDK 3.0. It is still,
+ however, supported and tested under the previous 2.x versions.
+
+ The image containing \B2Q stack for BeagleBoard-xM are included in \SDK,
+ ready to be copied to an SD card.
+
+ \section1 Preparing an SD Card
+
+ An SD card of at least 512 MB capacity is needed.
+
+ \include detect-sd-card-device-name.qdocinc instructions
+
+ \section1 Installing the \B2Q Image
+
+ To write the image to the SD card, ensure that no partitions on the
+ SD card are mounted:
+
+ \include detect-sd-card-device-name.qdocinc unmount
+
+ Then,
+
+ \badcode
+ cd <INSTALL_DIR>
+ sudo Boot2Qt-3.x/beagleboard-eLinux/images/deploy.sh /dev/<device_name>
+ \endcode
+
+ After the image has been deployed, power on the device and check that
+ the \B2Q welcome screen and/or demo appear.
+
+ \section1 Setting up USB Access
+
+ \include b2qt-post-install-setup.qdocinc setting up usb access
+
+ \section1 Configuring a Device Kit in Qt Creator
+
+ \include b2qt-post-install-setup.qdocinc configuring device kit
+
+ You are now ready to start developing for your device. For more information,
+ see \l{Building and Running an Example}.
+*/