diff options
| -rw-r--r-- | dist/README | 187 |
1 files changed, 125 insertions, 62 deletions
diff --git a/dist/README b/dist/README index 1206280265..2828cf1b37 100644 --- a/dist/README +++ b/dist/README @@ -1,95 +1,158 @@ -This is Qt version %VERSION%. -Qt is a comprehensive cross-platform C++ application framework. Qt 4 -introduces new features and many improvements over the 3.x series. See -http://qt.nokia.com/doc/latest/qt4-intro.html for details. +Welcome to Qt 5 +=============== -The Qt 4.x series is not binary compatible or source compatible with -the 3.x series. For more information on porting from Qt 3 to Qt 4, see -http://qt.nokia.com/doc/latest/porting4.html. +Qt is a cross-platform application and user interface framework. It +consists of a number of software libraries and development tools. +Qt is developed as an open source project. It is available under both +open source and commercial licenses. -INSTALLING Qt +All information on Qt is available on the Qt Developer Network: +http://qt-project.org -If you have a source package (a .tar.gz, or .zip file), follow the -instructions in the INSTALL file. +Be sure to check out the release notes, which will list any known +problems or limitations of this version: +http://qt-project.org/wiki/Category:Release -On Windows and Mac OS X, if you want to install the precompiled binary -packages, simply launch the package and follow the instructions in the -installation wizard. -For Mac OS X Carbon, the binary package requires Mac OS X 10.4 (Tiger) or -later and GCC 4.0.1 to develop applications. Its applications will run -on Mac OS X 10.4 and above. +Overview +-------- -For Mac OS X Cocoa, the binary package requires Mac OS X 10.5 (Leopard) or -later and GCC 4.0.1 to develop applications. Its applications will run -on Mac OS X 10.5 and above. +You can use the Qt 5 installation program to install the following components: -If you want to install the precompiled binary package for Symbian, -follow these instructions: -http://qt.nokia.com/doc/%SHORTVERSION%/install-symbian-installer.html +- Qt libraries, prebuilt for a particular development platform (operating system + and compiler) +- Qt Creator integrated development environment (IDE) +- Basic development tools, prebuilt for a particular development platform +- Documentation +- Qt in source code form (needed only if you want to build the framework and + tools yourself) +Install Qt libraries to develop or run applications that need the Qt runtimes or +to try out example applications built with Qt. -EXAMPLES +Qt Creator is designed to make Qt development easier, but you can also use a 3rd +party IDE (such as MS Visual Studio), or just an editor and command line, in +addition to basic Qt development tools (Qt Designer, Qt Assistant, qmlscene, and +so on). -Once Qt is installed, we suggest that you take a look at the examples -to see Qt in action. -For desktop computers, run the Qt Examples by opening them in Qt Creator. +Installing Qt 5 +--------------- -For embedded devices, launch the Qt 'fluidlauncher' example, either through -the platforms filebrowser or the built in menu system. +You can download Qt 5 from http://qt-project.org/downloads. The site provides +download links for all supported development platforms. +Start the installation program like any executable on the development platform. +On Linux, you might first have to make the installation program executable. -REFERENCE DOCUMENTATION +Select the components that you want to install and follow the instructions of +the installation program to complete the installation. -The Qt reference documentation is available locally in Qt's doc/html -directory. You can use Qt Assistant to view it; to launch Assistant, -type 'assistant' on the command line or use the Start menu. On Mac OS -X, you can find it in /Developer/Applications/Qt. The latest -documentation is available at http://qt.nokia.com/doc/. +Use the Maintenance Tool under <install_dir> to remove all installed +components. -SUPPORTED PLATFORMS +Directory Structure +------------------- -For a complete list of supported platforms, see -http://qt.nokia.com/doc/%SHORTVERSION%/supported-platforms.html. +The default top-level installation directory is the directory "Qt<version>" in +your home directory, but you can specify another directory (<install_dir>). Each +Qt version is installed in the <install_dir>/<version> directory. This +directory contains subdirectories for the Qt libraries (<compiler>), +documentation (doc), and sources (src). The <compiler> directory contains +subdirectories for development tools (bin) and examples. -COMMERCIAL EDITIONS +Starting Development Tools +-------------------------- -Desktop Edition licensees can use all the modules provided with their -Qt package. +You can start Qt Creator directly after the installation by selecting the option +on the last page of the installation program. You can start most of +the development tools, such as GUI designers, compilers, and debuggers +directly from Qt Creator. You can also access the installed documentation and +example applications from Qt Creator. -GUI Framework licensees may only use the classes contained in -the QtCore, QtGui (except QGraphicsView), QtTest, QtDBus and -Qt3Support modules. +The development tools are located in the directory +<install_dir>/<version>/<compiler>/bin. You can run them from Qt Creator or from +the command line. You can also launch some of them as standalone applications. +For example: -For a full listing of the contents of each module, please refer to -http://qt.nokia.com/doc/%SHORTVERSION%/modules.html +- Qt Assistant, the Qt documentation reader +- qmlscene, the viewer for Qt Quick2 declarative QML applications +- QMLViewer, the viewer for Qt Quick1 declarative QML applications +- Qt Designer, the GUI designer for Qt widgets-based applications -HOW TO REPORT A BUG +Running Example Applications +---------------------------- -If you think you have found a bug in Qt, we would like to hear about -it so that we can fix it. The Qt bug tracking system is open to the -public at http://bugreports.qt-project.org/. +You can open example applications in the Qt Creator Welcome mode to build and +run them. -Before reporting a bug, please use the bug-tracker's search functions -and consult http://qt.nokia.com/developer/faqs/ to see if the issue is -already known. +Ready to run example applications are located in +<install_dir>/<version>/<compiler>/examples. You can launch the C++ based +examples directly either from command line or your file system browser. -Always include the following information in your bug report: the name -and version number of your compiler; the name and version number of -your operating system; the version of Qt you are using, and what -configure options it was compiled with. +The QML based Quick 2 examples are located in +<install_dir>/<version>/<compiler>/examples/qtdeclarative. You can load them +using the qmlscene application. -If the problem you are reporting is only visible at run-time, try to -create a small test program that shows the problem when run. Often, -such a program can be created with some minor changes to one of the many -example programs in Qt's examples directory, or to the autotests that -are available in the public source repository on http://qt.gitorious.org/. +The QML based Quick 1 examples are located in +<install_dir>/<version>/<compiler>/examples/qtquick1. You can view them with the +QMLViewer application. -Qt is a trademark of Nokia Corporation and/or its subsidiary(-ies). +Building Qt 5 from Source +------------------------- + +See <install_dir>/<version>/src/README and +http://qt-project.org/wiki/Building-Qt-5-from-Git +for instructions on building Qt from source. + + +Developing Qt Applications +-------------------------- + +To develop a Qt application, you need to set up a project. Qt Creator contains +wizards that guide you step-by-step through the project creation process. The +wizards prompt you to enter the settings needed for a particular type of project +and create the necessary files for you. To start, select File > New File or +Project. + +The wizards create projects that use the Qt build tool, qmake. It is a +cross-platform system for build automation that helps simplify the build process +for development projects across different platforms. You can modify the build +and run settings for qmake projects in the Qt Creator Projects mode. + +Qt Creator provides support for building, running, and deploying Qt applications +for different target platforms, or using different compilers, debuggers, or +Qt versions. Kits define the tools, device type and other settings to use when +building and running your project. + +The Qt 5 installation program adds the installed Qt version +(<install_dir>/<version>/<compiler>/bin/qmake) to Qt Creator and creates a kit +that specifies the installed Qt version and compiler. To use the kit, add it for +your project in the Qt Creator Projects mode. Then select the kit in the Kit +selector before you build or run the project. + +To compile C++ Qt applications by some other means, add +<install_dir>/<version>/<compiler>/include to your build tool's search path +for include files, and <install_dir>/<version>/<compiler>/lib to the search +path for libraries. + + +Want to Know More? +------------------- + +Much more information is available at: + +- http://qt-project.org/resources/getting_started +- http://qt-project.org/doc/ +- http://qt-project.org + + +We hope you will enjoy using Qt! + +- The Qt developers @ qt-project.org |