Deploy an Application on Windows: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
h1. Deploy an Application on Windows
h1. Deploy an Application on Windows


This guide is written for Qt 5. It assumes that:<br />* The ''release version'' of your app works correctly when you build + run it from Qt Creator<br />* Your (dynamically-linked) copy of Qt is installed in C:.2.1\mingw48_32
This guide is written for Qt 5. It assumes that:
* The ''release version'' of your app works correctly when you build + run it from Qt Creator
* Your (dynamically-linked) copy of Qt is installed in C:.2.1\mingw48_32


== Overview ==
== Overview ==
Line 11: Line 13:
== Finding the Required Files ==
== Finding the Required Files ==


See &quot;Qt for Windows - Deployment&amp;quot;:http://doc.qt.io/qt-5/windows-deployment.html for the official instructions.
See "Qt for Windows - Deployment":http://doc.qt.io/qt-5/windows-deployment.html for the official instructions.


Sometimes though, the deployment might seem successful and your app launches, but some things don't work properly. Perhaps a window is blank, an image doesn't show, or a music file won't play. If this happens, you are probably missing a file that is only loaded at runtime (like a plug-in DLL).
Sometimes though, the deployment might seem successful and your app launches, but some things don't work properly. Perhaps a window is blank, an image doesn't show, or a music file won't play. If this happens, you are probably missing a file that is only loaded at runtime (like a plug-in DLL).
Line 36: Line 38:
# (If you used QML) Delete ''qmldir'' files from the folders that have no more DLLs or .qml files
# (If you used QML) Delete ''qmldir'' files from the folders that have no more DLLs or .qml files


When you have removed all the files that you don't need,<br /># Rename C:back to C:to restore your installation.<br /># Distribute your app.
When you have removed all the files that you don't need,
# Rename C:back to C:to restore your installation.
# Distribute your app.


== Appendix: How to ask for help ==
== Appendix: How to ask for help ==


If you still get stuck,<br /># Start a new post in the &quot;Qt Project forum&amp;quot;:http://forum.qt.io/viewforum/14/<br /># Say that you followed this guide. Say which attempts passed, and which attempts failed.<br /># Describe how it fails, and provide any error messages that you see.<br /># Provide a screenshot of the contents in C:
If you still get stuck,
# Start a new post in the "Qt Project forum":http://forum.qt.io/viewforum/14/
# Say that you followed this guide. Say which attempts passed, and which attempts failed.
# Describe how it fails, and provide any error messages that you see.
# Provide a screenshot of the contents in C:

Revision as of 08:44, 25 February 2015

h1. Deploy an Application on Windows

This guide is written for Qt 5. It assumes that:

  • The release version of your app works correctly when you build + run it from Qt Creator
  • Your (dynamically-linked) copy of Qt is installed in C:.2.1\mingw48_32

Overview

To deploy a Qt app, you'll need to gather files from a few different locations. Here is an example of an app that uses Qt Quick to display a picture (NOTE: PACKAGE-SPECIFIC DLLS ARE NOT SHOWN):

Where to find files for deployment

Finding the Required Files

See "Qt for Windows - Deployment":http://doc.qt.io/qt-5/windows-deployment.html for the official instructions.

Sometimes though, the deployment might seem successful and your app launches, but some things don't work properly. Perhaps a window is blank, an image doesn't show, or a music file won't play. If this happens, you are probably missing a file that is only loaded at runtime (like a plug-in DLL).

These files can be tricky to identify. Here is a systematic way to deploy successfully.

Initial deployment (Quick and dirty)

  1. Close Qt Creator.
  2. Copy the following into C:## The release version of MyApp.exe
    1. All the .dll files from C:.2.1\mingw48_32\bin## All the folders from C:.2.1\mingw48_32\plugins## (If you used QML) All the folders from C:.2.1\mingw48_32\qml# Rename C:to C: (This turns your PC into a clean environment, just like one that doesn't have Qt installed.)
  3. Launch C:.exe.

If your app worked correctly, congratulations! You are almost ready for deployment. You don't want to ship a 1.5GB package though, so it's time to clean up unused files.

If it didn't work correctly, ask for help (see the Appendix)

Final deployment (Cleaned up)

Do the deletion steps below in C:and all of its subdirectories. After each deletion, launch C:.exe and test it. If it stops working, restore the files you just deleted.

  1. Launch MyApp.exe. While it is running, try to delete all DLLs. The DLLs that aren't used will go to the recycle bin, leaving behind only the DLLs that you need. (This trick doesn't work for .qml and qmldir files, however).
  2. (If you used QML) Delete a few .qml files and try relaunching MyApp.exe. Repeat until you try all .qml files.
  3. (If you used QML) Delete qmldir files from the folders that have no more DLLs or .qml files

When you have removed all the files that you don't need,

  1. Rename C:back to C:to restore your installation.
  2. Distribute your app.

Appendix: How to ask for help

If you still get stuck,

  1. Start a new post in the "Qt Project forum":http://forum.qt.io/viewforum/14/
  2. Say that you followed this guide. Say which attempts passed, and which attempts failed.
  3. Describe how it fails, and provide any error messages that you see.
  4. Provide a screenshot of the contents in C: