Deploy an Application on Windows: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Fix migration errors; use uploaded image) |
||
| Line 1: | Line 1: | ||
This guide is written for Qt 5. It assumes that: | 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 | * 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 | * Your (dynamically-linked) copy of Qt is installed in C:\Qt\5.2.1\mingw48_32\ | ||
== Overview == | == Overview == | ||
| Line 9: | Line 7: | ||
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): | 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): | ||
[[ | [[File:Qt_Deployment_Structure_Windows.png]] | ||
== Finding the Required Files == | == Finding the Required Files == | ||
See | See [http://doc.qt.io/qt-5/windows-deployment.html Qt for Windows - Deployment] 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 22: | Line 20: | ||
# Close Qt Creator. | # Close Qt Creator. | ||
# Copy the following into C:## The ''release version'' of '''MyApp.exe''' | # Copy the following into C:\Deployment\ | ||
## 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. | ## The ''release version'' of '''MyApp.exe''' | ||
# Launch C:.exe. | ## All the '''.dll files''' from C:\Qt\5.2.1\mingw48_32\bin\ | ||
## All the '''folders''' from C:\Qt\5.2.1\mingw48_32\plugins\ | |||
## (If you used QML) All the '''folders''' from C:\Qt\5.2.1\mingw48_32\qml\ | |||
# Rename C:\Qt\ to C:\QtHidden\ (This turns your PC into a clean environment, just like one that doesn't have Qt installed). | |||
# Launch C:\Deployment\MyApp.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 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. | ||
| Line 32: | Line 34: | ||
=== Final deployment (Cleaned up) === | === 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. | Do the deletion steps below in C:\Deployment\ and all of its subdirectories. After each deletion, launch C:\Deployment\MyApp.exe and test it. If it stops working, restore the files you just deleted. | ||
# 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). | # 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). | ||
| Line 39: | Line 41: | ||
When you have removed all the files that you don't need, | When you have removed all the files that you don't need, | ||
# Rename C:back to C:to restore your installation. | # Rename C:\QtHidden\ back to C:\Qt\ to restore your installation. | ||
# Distribute your app. | # Distribute your app. | ||
| Line 45: | Line 47: | ||
If you still get stuck, | If you still get stuck, | ||
# Start a new post in the | # Start a new post in the [http://qt-project.org/forums/viewforum/14/ Qt Project forum] | ||
# Say that you followed this guide. Say which attempts passed, and which attempts failed. | # 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. | # Describe how it fails, and provide any error messages that you see. | ||
# Provide a screenshot of the contents in C: | # Provide a screenshot of the contents in C:\Deployment\ | ||
Remember: The more info you provide, the better your chances of getting a solution! | |||
Revision as of 12:43, 27 February 2015
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:\Qt\5.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):
Finding the Required Files
See Qt for Windows - Deployment 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)
- Close Qt Creator.
- Copy the following into C:\Deployment\
- The release version of MyApp.exe
- All the .dll files from C:\Qt\5.2.1\mingw48_32\bin\
- All the folders from C:\Qt\5.2.1\mingw48_32\plugins\
- (If you used QML) All the folders from C:\Qt\5.2.1\mingw48_32\qml\
- Rename C:\Qt\ to C:\QtHidden\ (This turns your PC into a clean environment, just like one that doesn't have Qt installed).
- Launch C:\Deployment\MyApp.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:\Deployment\ and all of its subdirectories. After each deletion, launch C:\Deployment\MyApp.exe and test it. If it stops working, restore the files you just deleted.
- 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).
- (If you used QML) Delete a few .qml files and try relaunching MyApp.exe. Repeat until you try all .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,
- Rename C:\QtHidden\ back to C:\Qt\ to restore your installation.
- Distribute your app.
Appendix: How to ask for help
If you still get stuck,
- Start a new post in the Qt Project forum
- 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:\Deployment\
Remember: The more info you provide, the better your chances of getting a solution!