Clean up README

Put specifics on how to build IFW from scratch to a separate INSTALL
file. Also remove details that are better put in the general
documentation.

Change-Id: If8ceed170cde3ef258e50311bbb3426c964c065c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>

2 files changed, 92 insertions, 59 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 000000000..3922b396f
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,69 @@
+How to build
+=====================
+
+The instructions should help you build the Installer Framework from scratch.
+
+
+Get the sources
+---------------------
+
+Use Git to check out the Qt Installer Framework sources that are hosted at:
+
+http://qt.gitorious.org/installer-framework
+
+
+Build Qt
+---------------------
+
+To build an installer, it is advised to use a statically linked Qt. For maximum
+portability we recommend the latest version of the Qt 4.x series. See the Qt
+documentation for the prerequisites and steps to build Qt from sources.
+
+### Windows
+
+Adjust the qmake.conf to have a real stand alone working installer:
+
+- add 'embed_manifest_dll embed_manifest_exe' to CONFIG line
+- replace -MD, -MDd with -MT, -MTD in the CFLAGS lines
+
+'git diff' should show you something like:
+
+--- a/mkspecs/win32-msvc20XX/qmake.conf
++++ b/mkspecs/win32-msvc20XX/qmake.conf
+
+ MAKEFILE_GENERATOR      = MSVC.NET
+ TEMPLATE                = app
+-CONFIG                  += qt warn_on release incremental flat link_prl precompile_header autogen_precompile_source copy_dir_files debug_and_release debug_and_release_target embed_manifest_dll embed_manifest_exe
++CONFIG                  += qt warn_on release incremental flat link_prl precompile_header autogen_precompile_source copy_dir_files debug_and_release debug_and_release_target
+ QT                      += core gui
+ DEFINES                 += UNICODE WIN32 QT_LARGEFILE_SUPPORT
+ QMAKE_COMPILER_DEFINES  += _MSC_VER=1400 WIN32
+ QMAKE_YACCFLAGS         = -d
+ QMAKE_CFLAGS            = -nologo -Zm200 -Zc:wchar_t-
+ QMAKE_CFLAGS_WARN_ON    = -W3
+ QMAKE_CFLAGS_WARN_OFF   = -W0
+-QMAKE_CFLAGS_RELEASE    = -O2 -MD
+-QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MD -Zi
+-QMAKE_CFLAGS_DEBUG      = -Zi -MDd
++QMAKE_CFLAGS_RELEASE    = -O2 -MT
++QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MT -Zi
++QMAKE_CFLAGS_DEBUG      = -Zi -MTd
+ QMAKE_CFLAGS_YACC       =
+ QMAKE_CFLAGS_LTCG       = -GL
+
+Recommended configure options for Microsoft Windows:
+
+configure.exe -opensource -release -static -no-multimedia -no-declarative -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -nomake examples -nomake demos
+
+### Linux & Mac OS X
+
+Recommended configure options for Linux and Mac OS X:
+
+configure -opensource -release -static -qt-zlib -qt-libtiff -qt-libpng -qt-libmng -qt-libjpeg -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -no-svg -nomake examples -nomake demos
+
+
+Build the Framework
+---------------------
+
+Run 'qmake && make' (or 'mingw32-make', 'nmake' ...) to build the Qt Installer
+Framework. The documentation can be generated by 'make docs'.
diff --git a/README b/README
index 32b24b101..1e4971e29 100644
--- a/README
+++ b/README
@@ -1,60 +1,24 @@
-These are instructions to create the Installer Framework
-
-== Build ==
-To build an installer, it is advised to use a statically linked Qt.
-
-== Qt configuration under Windows ==
-adjust the qmake.conf to have a real stand alone working installer (at the moment we are using msvc2005, but it should work with msvc2008 as well)
-
---- a/mkspecs/win32-msvc20XX/qmake.conf
-+++ b/mkspecs/win32-msvc20XX/qmake.conf
- 
- MAKEFILE_GENERATOR      = MSVC.NET
- TEMPLATE                = app
--CONFIG                  += qt warn_on release incremental flat link_prl precompile_header autogen_precompile_source copy_dir_files debug_and_release debug_and_release_target embed_manifest_dll embed_manifest_exe
-+CONFIG                  += qt warn_on release incremental flat link_prl precompile_header autogen_precompile_source copy_dir_files debug_and_release debug_and_release_target
- QT                      += core gui
- DEFINES                 += UNICODE WIN32 QT_LARGEFILE_SUPPORT
- QMAKE_COMPILER_DEFINES  += _MSC_VER=1400 WIN32
- QMAKE_YACCFLAGS         = -d
- QMAKE_CFLAGS            = -nologo -Zm200 -Zc:wchar_t-
- QMAKE_CFLAGS_WARN_ON    = -W3
- QMAKE_CFLAGS_WARN_OFF   = -W0
--QMAKE_CFLAGS_RELEASE    = -O2 -MD
--QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MD -Zi
--QMAKE_CFLAGS_DEBUG      = -Zi -MDd
-+QMAKE_CFLAGS_RELEASE    = -O2 -MT
-+QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MT -Zi
-+QMAKE_CFLAGS_DEBUG      = -Zi -MTd
- QMAKE_CFLAGS_YACC       =
- QMAKE_CFLAGS_LTCG       = -GL
-
-Recommended configure options for windows:
-configure.exe -opensource -release -static -no-multimedia -no-declarative -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -nomake examples -nomake demos
-
-Recommended configure options for Linux and MacOS:
-configure -opensource -release -static -qt-zlib -qt-libtiff -qt-libpng -qt-libmng -qt-libjpeg -no-phonon -no-dbus -no-opengl -no-qt3support -no-webkit -no-xmlpatterns -no-svg -nomake examples -nomake demos
- 
-== Create an Installer ==
-
-To create an installer, use bin/binarycreator. The create-test-installer batch files run it for the example project:
- 
-in windows;
-cd tests\test-installer
-create-test-installer.bat
-
-in unix;
-cd tests/test-installer
-create-test-installer.sh
-
-   NOTE: Under MacOS you have to copy the dir $QTDIR/src/gui/mac/qt_menu.nib to <INSTALLER_APP_DIR>/Resources/qt_menu.nib.
-         for example: cp -r ../../qt4/src/gui/mac/qt_menu.nib ./test-installer-offline.app/Contents/Resources
-
-This creates an installer "test-installer-offline"/"test-installer-online" and the components required by the com.nokia.testapp package(examples\testapp\packages\com.nokia.testapp) in the bin folder.
-
-== Create an Archive ==
-To create an 7zip archive named qt-copy.7z that contains the directory qt-copy use:
-
-cd /path/where/qt-copy/is/located
-7z a -t7z -mx=9 -ms=off -l qt-copy.7z qt-copy
+Qt Installer Framework
+==========================
 
+The Qt Installer Framework provides a set of tools and utilities to create
+installers for the supported desktop Qt platforms: Linux, Microsoft Windows, and
+Mac OS X.
+
+
+Documentation
+--------------------------
+
+The binary packages for the Qt Installer Framework include documentation in the
+doc directory. See http://qt-project.org/wiki/Qt-Installer-Framework for a link
+to online versions.
+
+
+Getting Help
+--------------------------
+
+If you think you found a bug, please report it to
+
+https://bugreports.qt-project.org/browse/QTIFW
+
+General questions are best asked on interest@qt-project.org.