summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoraavit <qt_aavit@ovi.com>2012-08-27 15:00:38 +0200
committerLars Knoll <lars.knoll@nokia.com>2012-08-27 15:23:52 +0200
commitd61e3d63883ff09aa28c8b214575c6abd8d25c6b (patch)
treeab2ce882b313454b44e4309e05cc95279cb790d6
parenta4b2b7848c6aa89521a69da40a246429bf360de5 (diff)
Updated package README: make it common for binary and source packagesv5.0.0-beta1
Change-Id: I91c53b006909e89e8234065910179240dd492dab Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
-rw-r--r--release-tools/dist/README.txt (renamed from release-tools/dist/binary-packages/README.txt)44
1 files changed, 31 insertions, 13 deletions
diff --git a/release-tools/dist/binary-packages/README.txt b/release-tools/dist/README.txt
index a94601a..9878453 100644
--- a/release-tools/dist/binary-packages/README.txt
+++ b/release-tools/dist/README.txt
@@ -19,18 +19,26 @@ http://qt-project.org/wiki/Category:Release
Understanding the Qt packages: Have you installed the right one?
----------------------------------------------------------------
-This package contains a binary distribution of Qt. It contains the the
-Qt libraries and basic development tools, prebuilt for a certain
-platform (operating system and compiler).
+The Qt source package ("qt-everywhere-opensource-src-<version>.xxx")
+contains Qt in source code form. It is the right choice if you want to
+build the framework and tools yourself.
-Note that this package does NOT contain Qt Creator, i.e. Qt's IDE
+The binary Qt packages ("qt-<operatingsystem>-opensource-<version>.xxx")
+contain a binary distribution of Qt. It contains the the Qt libraries
+and basic development tools, prebuilt for a certain platform
+(operating system and compiler). The binary package also contains a
+copy of the source package, as an optional install.
+
+Note that the Qt packages do NOT contain Qt Creator, i.e. Qt's IDE
(Integrated Development Environment) application. If you are a
developer and you find yourself asking "How do I start Qt?", then you
-should install Qt Creator, which comes in a separate package. The Qt
-SDK (Software Development Kit) packages combine Qt Creator and a
-binary Qt distribution in a single handy install.
+should install Qt Creator, which comes in a separate package.
+
+Finally, there are also the Qt SDK (Software Development Kit)
+packages, which combine Qt Creator and a binary Qt distribution in a
+single handy install.
-This binary package is the right choice if you either
+The binary package is the right choice if you either
- Just need the Qt runtimes in order to run another application that
needs them, or
- Want to try out some example programs built with Qt, or
@@ -46,13 +54,15 @@ Directory structure
The default top-level installation directory is the
directory "Qt-[version]" in your home directory.
-The base directory of this particular binary distribution is something
+The base directory of a particular binary distribution is something
similar to [installdir]/Desktop/Qt/[version]/[compiler]. This basedir
contains a number of subdirectories; "bin", "doc", "examples", etc.
+The source code, if installed, can be found under [installdir]/Src.
+
-Starting the development tools
-------------------------------
+Starting the development tools (binary package)
+-----------------------------------------------
The directory [basedir]/bin contains all the Qt development
tools. Most are intended to be used from command line or an IDE, but
@@ -63,8 +73,8 @@ QMLViewer: Viewer for Qt Quick1 declarative QML applications
Designer: GUI designer for Qt widgets-based applications.
-Running the example programs
-----------------------------
+Running the example programs (binary package)
+---------------------------------------------
Ready to run example programs can be found in [basedir]/examples. The
C++ based examples can be launched directly either from command line or
@@ -77,6 +87,14 @@ The QML based Quick 1 examples are in [basedir]/examples/qtquick1. They
can be run with the QMLViewer application (ref. above).
+Building Qt from source
+-----------------------
+
+See [installdir]/Src/Qt/[version]/README and
+http://qt-project.org/wiki/Building_Qt_5_from_Git
+for instructions on building Qt from source.
+
+
Using it for developing software
--------------------------------