"Fossies" - the Fresh Open Source Software Archive 
Member "qt-everywhere-src-6.3.1/qtbase/dist/README" (25 May 2022, 5535 Bytes) of package /linux/misc/qt-everywhere-src-6.3.1.tar.xz:
As a special service "Fossies" has tried to format the requested text file into HTML format (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
1
2 Welcome to Qt 5
3 ===============
4
5 Qt is a cross-platform application and user interface framework. It
6 consists of a number of software libraries and development tools.
7
8 Qt is developed as an open source project. It is available under both
9 open source and commercial licenses.
10
11 All information on Qt is available on the Qt Developer Network:
12 http://qt-project.org
13
14 Be sure to check out the release notes, which will list any known
15 problems or limitations of this version:
16 https://wiki.qt.io/Category:Release
17
18
19 Overview
20 --------
21
22 You can use the Qt 5 installation program to install the following components:
23
24 - Qt libraries, prebuilt for a particular development platform (operating system
25 and compiler)
26 - Qt Creator integrated development environment (IDE)
27 - Basic development tools, prebuilt for a particular development platform
28 - Documentation
29 - Qt in source code form (needed only if you want to build the framework and
30 tools yourself)
31
32 Install Qt libraries to develop or run applications that need the Qt runtimes or
33 to try out example applications built with Qt.
34
35 Qt Creator is designed to make Qt development easier, but you can also use a 3rd
36 party IDE (such as MS Visual Studio), or just an editor and command line, in
37 addition to basic Qt development tools (Qt Designer, Qt Assistant, qmlscene, and
38 so on).
39
40
41 Installing Qt 5
42 ---------------
43
44 You can download Qt 5 from http://qt-project.org/downloads. The site provides
45 download links for all supported development platforms.
46
47 Start the installation program like any executable on the development platform.
48 On Linux, you might first have to make the installation program executable.
49
50 Select the components that you want to install and follow the instructions of
51 the installation program to complete the installation.
52
53 Use the Maintenance Tool under <install_dir> to remove all installed
54 components.
55
56
57 Directory Structure
58 -------------------
59
60 The default top-level installation directory is the directory "Qt<version>" in
61 your home directory, but you can specify another directory (<install_dir>). On
62 Windows, however, the default top-level installation directory is "C:\Qt\Qt<version>".
63 Each Qt version is installed in the <install_dir>/<version> directory. This directory
64 contains subdirectories for the Qt libraries (<compiler>) and sources (Src).
65 The <compiler> directory contains subdirectories for development tools (bin) and
66 examples.
67
68
69 Starting Development Tools
70 --------------------------
71
72 You can start Qt Creator directly after the installation by selecting the option
73 on the last page of the installation program. You can start most of
74 the development tools, such as GUI designers, compilers, and debuggers
75 directly from Qt Creator. You can also access the installed documentation and
76 example applications from Qt Creator.
77
78 The development tools are located in the directory
79 <install_dir>/<version>/<compiler>/bin. You can run them from Qt Creator or from
80 the command line. You can also launch some of them as standalone applications.
81 For example:
82
83 - Qt Assistant, the Qt documentation reader
84 - Qt QML Scene, the viewer for Qt Quick 2 files
85 and - Qt Designer, the GUI designer for Qt widgets-based applications
86
87 You can use Qt Creator to develop with other Qt versions as well:
88
89 http://qt-project.org/doc/qtcreator-2.6/creator-project-qmake.html
90
91
92 Running Example Applications
93 ----------------------------
94
95 You can open most example applications in the Qt Creator Welcome mode to build
96 and run them. Additional examples can be opened by browsing
97 <install_dir>/<version>/<compiler>/examples.
98
99 Building Qt 5 from Source
100 -------------------------
101
102 See <install_dir>/<version>/src/README and
103 http://wiki.qt.io/Building_Qt_5_from_Git
104 for instructions on building Qt from source.
105
106
107 Developing Qt Applications
108 --------------------------
109
110 To develop a Qt application, you need to set up a project. Qt Creator contains
111 wizards that guide you step-by-step through the project creation process. The
112 wizards prompt you to enter the settings needed for a particular type of project
113 and create the necessary files for you. To start, select File > New File or
114 Project.
115
116 The wizards create projects that use the Qt build tool, qmake. It is a
117 cross-platform system for build automation that helps simplify the build process
118 for development projects across different platforms. You can modify the build
119 and run settings for qmake projects in the Qt Creator Projects mode.
120
121 Qt Creator provides support for building, running, and deploying Qt applications
122 for different target platforms, or using different compilers, debuggers, or
123 Qt versions. Kits define the tools, device type and other settings to use when
124 building and running your project.
125
126 The Qt 5 installation program adds the installed Qt version
127 (<install_dir>/<version>/<compiler>/bin/qmake) to Qt Creator and creates a kit
128 that specifies the installed Qt version and compiler. To use the kit, add it for
129 your project in the Qt Creator Projects mode. Then select the kit in the Kit
130 selector before you build or run the project.
131
132 To compile C++ Qt applications by some other means, add
133 <install_dir>/<version>/<compiler>/include to your build tool's search path
134 for include files, and <install_dir>/<version>/<compiler>/lib to the search
135 path for libraries.
136
137
138 Want to Know More?
139 -------------------
140
141 Much more information is available at:
142
143 - http://qt-project.org/resources/getting_started
144 - http://qt-project.org/doc/
145 - http://qt-project.org
146
147
148 We hope you will enjoy using Qt!
149
150 - The Qt developers @ qt-project.org