| 1 |
Scripts to install compiled digiKam dependencies with MSVC under Windows |
| 2 |
======================================================================== |
| 3 |
|
| 4 |
* RESUME |
| 5 |
|
| 6 |
These scripts build a binary digiKam installer for Windows x86_64 under Windows using VCPKG, MSVC tool-chain, |
| 7 |
and NSIS application. |
| 8 |
|
| 9 |
These scripts follow instructions from Qt bundle deployment for Windows as shared libraries |
| 10 |
available at this url: https://doc.qt.io/qt-6/windows-deployment.html |
| 11 |
|
| 12 |
* AUTHORS |
| 13 |
|
| 14 |
(c) Gilles Caulier <caulier dot gilles at gmail dot com> |
| 15 |
|
| 16 |
* DESCRIPTION |
| 17 |
|
| 18 |
These files and scripts are used to make binary installer of the digiKam |
| 19 |
Software Collection for Windows Intel 64 bits. In addition to this README, |
| 20 |
there are comments in the scripts that provide some additional explanations for |
| 21 |
how they work. |
| 22 |
|
| 23 |
* BUNDLE CONTENTS |
| 24 |
|
| 25 |
Note: the bundle is relocatable and compatible with Windows 10 and later. |
| 26 |
|
| 27 |
``` |
| 28 |
| Executable, shared dlls, KDE plugins dlls, qt.conf |
| 29 |
|--- data |
| 30 |
| |--- audio Marble data files |
| 31 |
| |--- bitmaps Marble data files |
| 32 |
| |--- digikam digiKam data files |
| 33 |
| |--- flags Marble data files |
| 34 |
| |--- kconf_update Really need ? |
| 35 |
| |--- kf6 Really need ? |
| 36 |
| | |--- kauth |
| 37 |
| | |--- kcharselect |
| 38 |
| |--- knotifications6 Really need ? |
| 39 |
| |--- kstyle Breeze theme definitions |
| 40 |
| |--- kxmlgui5 KDE xml gui description files |
| 41 |
| | |--- digikam |
| 42 |
| | |--- showfoto |
| 43 |
| |--- lensfun Lensfun data files |
| 44 |
| |--- licenses License data files |
| 45 |
| |--- locale KDE GUI translations |
| 46 |
| |--- maps Marble data files |
| 47 |
| |--- mwdbii Marble data files |
| 48 |
| |--- naturalearth Marble data files |
| 49 |
| |--- placemarks Marble data files |
| 50 |
| |--- showfoto Showfoto data files |
| 51 |
| |--- solid Solid service descriptions |
| 52 |
| |--- stars Marble data files |
| 53 |
| |--- svg Marble data files |
| 54 |
| |-- weather Marble data files |
| 55 |
|--- etc |
| 56 |
| |-- xdg Really need ? |
| 57 |
| |-- ui |
| 58 |
|--- plugins Qt plugins, digiKam plugins, Marble plugins |
| 59 |
|--- share Really need ? |
| 60 |
| |-- mime FreeDesktop type-mime definitions. |
| 61 |
| |-- xdg Really need ? |
| 62 |
| |-- menus |
| 63 |
|-- translations Qt GUI translations |
| 64 |
``` |
| 65 |
|
| 66 |
* REQUIREMENTS |
| 67 |
|
| 68 |
- VirtualBox 7.x + guest extension pack https://www.virtualbox.org/wiki/Downloads |
| 69 |
+ Memory : 24 Gb Note: QtWebEngine requires a lots of memory with parallelized build |
| 70 |
+ CPU : 8 Very important: do not assign more CPU to compile QtWebEngine, else required memory become huge. |
| 71 |
+ Disk0 : VDI static NTFS 150 Gb C:/ SYSTEM VCPKG cache build target on $HOME/AppData/Local/vcpkg/archives |
| 72 |
+ Disk1 : VDI static NTFS 500 Gb E:/ DATA for the build, download, install storage |
| 73 |
|
| 74 |
- Windows 10 22H2 or later https://www.microsoft.com/en-us/software-download/windows10 |
| 75 |
|
| 76 |
- Git 2.42 or later https://git-scm.com/download/win |
| 77 |
+ Git-bash console |
| 78 |
+ Bundled OpenSSH |
| 79 |
+ OpenSSH library |
| 80 |
+ Checkout/Commit Unix EOL |
| 81 |
+ MinTTY Terminal |
| 82 |
|
| 83 |
- NSIS 3.x https://nsis-dev.github.io/ |
| 84 |
|
| 85 |
- IcoUtils 0.32 or later https://sourceforge.net/projects/unix-utils/files/icoutils/ |
| 86 |
+ Uncompress the binary archive to C:/icoutils |
| 87 |
|
| 88 |
- WinFlexBison 2.5 or later https://github.com/lexxmark/winflexbison/releases |
| 89 |
+ Uncompress the binary archive to C:/bison |
| 90 |
|
| 91 |
- RSync 3.2 or later for git-bash MSys repo: https://repo.msys2.org/msys/x86_64/ |
| 92 |
+ Tutorial https://prasaz.medium.com/add-rsync-to-windows-git-bash-f42736bae1b3 |
| 93 |
+ Install Msys/RSync and deps packages |
| 94 |
+ target: git-bash/usr install directory C:/Program Files/Git/usr/ |
| 95 |
|
| 96 |
- MC 4.8 or later for git-bash MSys repo: https://repo.msys2.org/msys/x86_64/ |
| 97 |
+ Install Msys/mc and deps packages libssh2 ; glib2 |
| 98 |
+ target: git-bash/usr install directory C:/Program Files/Git/usr/ |
| 99 |
|
| 100 |
- Visual Studio 2022 or later https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2022 |
| 101 |
+ Desktop development with C++ |
| 102 |
+ C++ core desktop features |
| 103 |
+ MSVC v143 - VS2022 C++ x64/x86 |
| 104 |
+ Windows 11 SDK >= 10.0.22621.0 |
| 105 |
+ Just in time debugger (optional) |
| 106 |
+ C++ Cmake tools for windows |
| 107 |
+ C++ ATL for latest v143 build tools |
| 108 |
+ C++ MFC for latest v143 build tools |
| 109 |
+ C++/CLI support for v143 |
| 110 |
+ C++ Clang tools for Windows (16.0.5) |
| 111 |
+ C++ Profiling tools. For dumpbin.exe tool. |
| 112 |
+ C++ Desktop tools. For mt.exe tool. |
| 113 |
|
| 114 |
- ImageMagick 7.1 or later https://imagemagick.org/script/download.php#windows |
| 115 |
+ x64 Version with Q16 and HDR support Note: IM version compiled with MSVC |
| 116 |
+ Install only C/C++ headers and libraries |
| 117 |
+ Disable all others features Note: in 'Addition Tasks' step |
| 118 |
+ Use default install path in C:/ |
| 119 |
|
| 120 |
* BUILD |
| 121 |
|
| 122 |
You must set the digiKam git tags to checkout right source code in installer. |
| 123 |
You must set the option to host debug symbols or not in installer. |
| 124 |
|
| 125 |
Note: Look in config.sh file for settings details. |
| 126 |
|
| 127 |
There are 4 scripts to be run by the user. 2 first ones installs |
| 128 |
VCPKG and all dependencies, next one digiKam, and last one makes a |
| 129 |
binary installer for Windows. |
| 130 |
|
| 131 |
To start compilation use these scripts in a Git-bash terminal: |
| 132 |
|
| 133 |
1) ./01-build-vcpkg.sh |
| 134 |
|
| 135 |
To build and install the base of VCPKG tools-chain including Qt framework and all low level dependencies. |
| 136 |
|
| 137 |
NOTE: due to long path problems while compiling under Windows and MSVC, VCPKG working directories must adjusted as shortest as possible: |
| 138 |
VCPKG_DIR=E:/vcpkg/ |
| 139 |
INSTALL_DIR=E:/dk/ |
| 140 |
DOWNLOAD_DIR=E:/d/ |
| 141 |
BUILDING_DIR=E:/b/ |
| 142 |
|
| 143 |
See the config.sh for details. Directories will be created automatically. |
| 144 |
|
| 145 |
2) ./02-build-extralibs.sh |
| 146 |
|
| 147 |
To Build and install the KDE framework components. |
| 148 |
|
| 149 |
3) ./03-build-digikam.sh |
| 150 |
|
| 151 |
To build and install digiKam and 3rd party plugins. |
| 152 |
|
| 153 |
4) ./04-build-installer.sh |
| 154 |
|
| 155 |
To build the Windows installer. Once you've successfully built digiKam, files to bundle may contain over 4GB of files. |
| 156 |
This script grabs the ~300MB needed to run digiKam and Showfoto. |
| 157 |
These include applications translations. |
| 158 |
|
| 159 |
This script creates Windows application links for the programs that will |
| 160 |
be run by the user (digiKam and Showfoto). It use makensis CLI tool from NSIS |
| 161 |
application dedicated to build Windows installer. |
| 162 |
The version >= 3 is required to be compatible with Windows 10. |
| 163 |
|
| 164 |
Depending of configuration done in config.sh, this script is able to upload automatically |
| 165 |
the bundle file on files.kde.org digiKam area through ssh. A valid ssh key configured |
| 166 |
with remote KDE server need to be set previously with the account. You can load ssh key |
| 167 |
at startup following instruction give at this url: |
| 168 |
|
| 169 |
https://unix.stackexchange.com/questions/90853/how-can-i-run-ssh-add-automatically-without-password-prompt |
| 170 |
|
| 171 |
Note: the bundle can be signed with GPG. You must setup your private and public keys before |
| 172 |
and put your passphare to a text file (~/.gnupg/dkorg-gpg-pwd.txt) |
| 173 |
|
| 174 |
* EXTRA SCRIPTS |
| 175 |
|
| 176 |
makeall.sh |
| 177 |
|
| 178 |
This script allows to build whole 64 bits installers from scratch. |
| 179 |
|
| 180 |
update.sh |
| 181 |
|
| 182 |
This script re-build only digiKam and installers 64 bits. |
| 183 |
|
| 184 |
* SSH CONFIGURATION |
| 185 |
|
| 186 |
Git-bash include openssh for windows which needs some tune to work properly with the remote KDE servers: |
| 187 |
|
| 188 |
- To register the git credential with your RSA key stored in C:/Users/${USER}/.ssh, |
| 189 |
create a C:/Users/${USER}/.bash_profile with this code: |
| 190 |
|
| 191 |
``` |
| 192 |
eval `ssh-agent` |
| 193 |
|
| 194 |
added_keys=`ssh-add -l` |
| 195 |
echo "Registered ssh keys: $added_keys" |
| 196 |
|
| 197 |
if [ ! $(echo $added_keys | grep -o -e "$HOME/.ssh/id_rsa") ] ; then |
| 198 |
ssh-add "$HOME/.ssh/id_rsa" & |
| 199 |
fi |
| 200 |
``` |
| 201 |
Git password will be ask once when the git-bash terminal session will be open. |
| 202 |
|
| 203 |
- To prevent unexpected disconnections from the remote server, |
| 204 |
create a C:/Users/{USER}/.ssh/ssh_config with this settings: |
| 205 |
|
| 206 |
``` |
| 207 |
Host * |
| 208 |
ServerAliveInterval 20 |
| 209 |
TCPKeepAlive no |
| 210 |
``` |
| 211 |
|
| 212 |
* LICENSES |
| 213 |
|
| 214 |
The scripts and other contents of this package are licensed |
| 215 |
under the GNU General Public License version 2, or any later version. |