dist/README

   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 http://qt-project.org/wiki/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>). Each
  62 Qt version is installed in the <install_dir>/<version> directory. This
  63 directory contains subdirectories for the Qt libraries (<compiler>),
  64 documentation (doc), and sources (src). The <compiler> directory contains
  65 subdirectories for development tools (bin) and examples.
  66
  67
  68 Starting Development Tools
  69 --------------------------
  70
  71 You can start Qt Creator directly after the installation by selecting the option
  72 on the last page of the installation program. You can start most of
  73 the development tools, such as GUI designers, compilers, and debuggers
  74 directly from Qt Creator. You can also access the installed documentation and
  75 example applications from Qt Creator.
  76
  77 The development tools are located in the directory
  78 <install_dir>/<version>/<compiler>/bin. You can run them from Qt Creator or from
  79 the command line. You can also launch some of them as standalone applications.
  80 For example:
  81
  82 - Qt Assistant, the Qt documentation reader
  83 - qmlscene, the viewer for Qt Quick2 declarative QML applications
  84 - QMLViewer, the viewer for Qt Quick1 declarative QML applications
  85 - Qt Designer, the GUI designer for Qt widgets-based applications
  86
  87
  88 Running Example Applications
  89 ----------------------------
  90
  91 You can open example applications in the Qt Creator Welcome mode to build and
  92 run them.
  93
  94 Ready to run example applications are located in
  95 <install_dir>/<version>/<compiler>/examples. You can launch the C++ based
  96 examples directly either from command line or your file system browser.
  97
  98 The QML based Quick 2 examples are located in
  99 <install_dir>/<version>/<compiler>/examples/qtdeclarative. You can load them
 100 using the qmlscene application.
 101
 102 The QML based Quick 1 examples are located in
 103 <install_dir>/<version>/<compiler>/examples/qtquick1. You can view them with the
 104 QMLViewer application.
 105
 106
 107 Building Qt 5 from Source
 108 -------------------------
 109
 110 See <install_dir>/<version>/src/README and
 111 http://qt-project.org/wiki/Building-Qt-5-from-Git
 112 for instructions on building Qt from source.
 113
 114
 115 Developing Qt Applications
 116 --------------------------
 117
 118 To develop a Qt application, you need to set up a project. Qt Creator contains
 119 wizards that guide you step-by-step through the project creation process. The
 120 wizards prompt you to enter the settings needed for a particular type of project
 121 and create the necessary files for you. To start, select File > New File or
 122 Project.
 123
 124 The wizards create projects that use the Qt build tool, qmake. It is a
 125 cross-platform system for build automation that helps simplify the build process
 126 for development projects across different platforms. You can modify the build
 127 and run settings for qmake projects in the Qt Creator Projects mode.
 128
 129 Qt Creator provides support for building, running, and deploying Qt applications
 130 for different target platforms, or using different compilers, debuggers, or
 131 Qt versions. Kits define the tools, device type and other settings to use when
 132 building and running your project.
 133
 134 The Qt 5 installation program adds the installed Qt version
 135 (<install_dir>/<version>/<compiler>/bin/qmake) to Qt Creator and creates a kit
 136 that specifies the installed Qt version and compiler. To use the kit, add it for
 137 your project in the Qt Creator Projects mode. Then select the kit in the Kit
 138 selector before you build or run the project.
 139
 140 To compile C++ Qt applications by some other means, add
 141 <install_dir>/<version>/<compiler>/include to your build tool's search path
 142 for include files, and <install_dir>/<version>/<compiler>/lib to the search
 143 path for libraries.
 144
 145
 146 Want to Know More?
 147 -------------------
 148
 149 Much more information is available at:
 150
 151 - http://qt-project.org/resources/getting_started
 152 - http://qt-project.org/doc/
 153 - http://qt-project.org
 154
 155
 156 We hope you will enjoy using Qt!
 157
 158 - The Qt developers @ qt-project.org