1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\contentspage {index.html}{Qt Installer Framework}
\previouspage ifw-use-cases-settings.html
\page ifw-tutorial.html
\nextpage ifw-creating-installers.html
\title Tutorial: Creating an Installer
This tutorial describes how to create a simple installer for a small
project:
\image ifw-introduction-page.png "Introduction page"
This section describes the following tasks that you must accomplish to
create the installer:
\list 1
\o Create a \e {package directory} that will contain all the
configuration files and installable packages.
\o Create a \e {configuration file} that contains information about how
to build the installer binaries and online repositories.
\o Create a \e {package information file} that contains information
about the installable components.
\o Create installer content and copy it to the package directory.
\o Use the \c binarycreator tool to create the \e installer.
The installer pages are created by using the information you provide
in the configuration and package information file.
\endlist
The example files are located in the \c{examples\tutorial} directory in the
Qt Installer Framework repository.
\section1 Creating a Package Directory
Create a directory structure that reflects the design of the installer and
allows the installer to be extended in the future. The directory must
contain subdirectories called \c config and \c packages.
\image ifw-tutorial-files.png
For more information about the package directory, see \l{Package Directory}.
\section1 Creating a Configuration File
In the \c config directory, create a file called \c config.xml with the
following contents:
\quotefile ../examples/tutorial/config/config.xml
The configuration file specifies the following information that is
displayed on the introduction page:
\list
\o The \c Title section specifies the installer name displayed on the
title bar (1).
\o The \c Name section specifies the application name that is added to
the page name and introduction text (2).
\endlist
\image ifw-tutorial-introduction-page.png "Introduction page"
For more information about the configuration file format and the available
settings, see \l{Configuration File}.
\section1 Creating a Package Information File
In this easy scenario, the installer handles only one component that is
called \c{com.vendor.product}. To provide the installer with information
about the component, create a file called \c package.xml with the
following contents and place it in the \c meta directory:
\quotefile ../examples/tutorial/packages/com.vendor.product/meta/package.xml
For more information about the package information file, see
\l{Package Information File Syntax}.
\section2 Specifying Component Information
The package information file specifies the following information that is
displayed on the component selection page:
\list
\o The \c DisplayName section specifies the name of the component in
the list of components (1).
\o The \c Description section specifies the text that is displayed when
the component is selected (2).
\endlist
\image ifw-tutorial-select-components.png
\section2 Specifying Installer Version
The \c Version section enables you to promote updates to users when they
become available.
\section2 Adding Licenses
The \c License section specifies the name of the file that contains the text
for the license agreement (1) that is displayed on the license check page:
\image ifw-tutorial-license-check.png "License check page"
\note To create installers for multiple platforms, including Windows,
make sure that the line endings of the license file use the CRLF
format, as Windows does not apply Linux line endings correctly.
\section2 Selecting Default Contents
The \c Default section specifies whether the component is selected by
default. The value \c true sets the component as selected. In this example,
we use the value \c script to resolve the value during runtime. The
name of the script file, installscript.qs, is specified in the \c Script
section.
The script file should look as follows:
\quotefile ../examples/tutorial/packages/com.vendor.product/meta/installscript.qs
\section1 Creating Installer Content
Content to be installed is stored in the \c data directory of a component.
As there is only one component, place the data in the
\c{packages/com.vendor.product/data} directory. The example already contains
a file for testing purposes, but you can place basically any files in the
directory.
For more information about packaging rules and options, see
\l{Data Directory}.
\section1 Creating the Installer Binary
You are now ready to create your first installer. Switch to the
\a tutorial directory on the command line. To create an installer called
YourInstaller.exe that contains the packages identified by
com.vendor.product, enter the following command:
\list
\o On Windows:
\code
..\..\bin\binarycreator.exe -c config\config.xml -p packages YourInstaller.exe
\endcode
\o On Linux or Mac OS X:
\code
../../bin/binarycreator -c config\config.xml -p packages YourInstaller
\endcode
\endlist
\note You have to either call \c lrelease on the included .ts file before building
the installer or add \c --ignore-translations as a parameter to the binarycreator
call.
The installer is created in the current directory and you can deliver it to
end users.
For more information about using the \c binarycreator tool, see
\l{binarycreator}.
\note If an error message is displayed when you run the tutorial installer,
check that you used a statically built Qt to create the installer. For more
information, see \l{Configuring Qt}.
*/
|
