Warning, /graphics/digikam/project/bundles/mxe/README.md is written in an unsupported language. File is not indexed.

0001 * RESUME
0002 
0003     These scripts build a binary digiKam installer for Windows under Linux using cross-compiler
0004     environment MXE and NSIS application.
0005 
0006     These scripts follow instructions from Qt bundle deployment for Windows as shared libraries
0007     available at this url: http://doc.qt.io/qt-5/windows-deployment.html
0008 
0009     Important: the MXE tool-chain is deprecated since 8.2.0 and have been replaced by VCPKG.
0010 
0011 * AUTHORS
0012 
0013     (c) 2015-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
0014 
0015 
0016 * DESCRIPTION
0017 
0018     These files and scripts are used to make binary installer of the digiKam
0019     Software Collection for Windows 64 bits. In addition to this README,
0020     there are comments in the scripts that provide some additional explanations for
0021     how they work.
0022 
0023     Note: these cross-compiling scripts exists because the way provided to compile
0024     a KDE application under Windows with MSVC compiler is just a big pain to
0025     use/configure/run with a Windows system.
0026     Another big advantage of cross-compiling is to not require a Windows to do the job, which
0027     is definitively a weird operating system to compile and hack. There is also no risk to
0028     inject a virus in the binary installer.
0029 
0030 * BUNDLE CONTENTS
0031 
0032     Note: the bundle is relocatable and compatible with Windows 7 and later.
0033 
0034     |                                                    Executable, shared dlls, KDE plugins dlls, qt.conf
0035     |--- data
0036     |   |--- audio                                       Marble data files
0037     |   |--- bitmaps                                     Marble data files
0038     |   |--- digikam                                     digiKam data files
0039     |   |--- flags                                       Marble data files
0040     |   |--- kconf_update                                Really need ?
0041     |   |--- kf5                                         Really need ?
0042     |   |   |--- kauth
0043     |   |   |-- kcharselect
0044     |   |--- knotifications5                             Really need ?
0045     |   |--- kservices5                                  KDE service descriptions
0046     |   |--- kservicetypes5                              KDE service type definitions
0047     |   |--- kxmlgui5                                    KDE xml gui description files
0048     |   |   |--- digikam
0049     |   |   |-- showfoto
0050     |   |--- lensfun                                     Lensfun data files
0051     |   |--- locale                                      KDE GUI translations
0052     |   |--- maps                                        Marble data files
0053     |   |--- mwdbii                                      Marble data files
0054     |   |--- naturalearth                                Marble data files
0055     |   |--- placemarks                                  Marble data files
0056     |   |--- showfoto                                    Showfoto data files
0057     |   |--- solid                                       Solid service descriptions
0058     |   |--- stars                                       Marble data files
0059     |   |--- svg                                         Marble data files
0060     |   |-- weather                                      Marble data files
0061     |--- etc                                             Really need ?
0062     |   |-- xdg
0063     |       |-- ui
0064     |--- plugins                                         Qt plugins
0065     |--- share                                           Really need ?
0066     |   |-- xdg
0067     |       |-- menus
0068     |-- translations                                     Qt GUI translations
0069 
0070 * REQUIREMENTS
0071 
0072     The scripts build digiKam with MXE cross compiler, so you will need all dependencies
0073     and the other pre-requisites first for MXE.
0074 
0075     See http://mxe.cc/#requirements for details.
0076 
0077     NSIS CLI program is required to build final Windows installer.
0078     IcoTool CLI program from IcoUtils package is required to integrate application icons to target executables.
0079 
0080     IMPORTANT:
0081     - You must set the right target architecture : windows 32 or 64 bits.
0082     - You must set the digiKam git tags to checkout right source code in installer.
0083     - You must set the option to host debug symbols or not in installer.
0084 
0085     Note: Look in config.sh file for settings details.
0086 
0087 * COMPONENTS
0088 
0089     There are 4 scripts to be run by the user. 2 first ones installs
0090     MXE and all dependencies, next one digiKam, and last one makes a 
0091     binary installer for Windows.
0092 
0093 * SCRIPT DESCRIPTIONS
0094 
0095     All scripts should be run from within this directory.
0096 
0097     * 01-build-mxe.sh:
0098 
0099     This script downloads and configures a custom install
0100     of MXE to ./build.
0101 
0102     * 02-build-extralibs.sh:
0103 
0104     This script configures, and compile a install to ./build
0105     of extra libraries, including KF5 frameworks, and most important photo management
0106     libs used by digiKam as Exiv2 and LensFun.
0107 
0108     * 03-build-digikam.sh:
0109 
0110     This script configures, and compile a custom install of digiKam to ./build.
0111 
0112     * 04-build-installer.sh:
0113 
0114     Once you've successfully built digiKam, the build directory may contain over 4GB of files.
0115     This script grabs the ~200MB needed to run digiKam and showfoto.
0116     These include applications translations.
0117 
0118     This script creates Windows application links for the programs that will
0119     be run by the user (digiKam and Showfoto). It use makensis CLI tool from NSIS
0120     application dedicated to build Windows installer. This one is available for Linux
0121     as Mingw package. The version >= 3 is required to be compatible with Windows 10.
0122 
0123     Depending of configuration done in config.sh, this script is able to upload automatically
0124     the bundle file on files.kde.org digiKam area through ssh. A valid ssh key configured
0125     with remote KDE server need to be set previously with the account. You can load ssh key
0126     at startup following instruction give at this url:
0127 
0128     https://unix.stackexchange.com/questions/90853/how-can-i-run-ssh-add-automatically-without-password-prompt
0129 
0130     Note: the bundle can be signed with GPG. You must setup your private and public keys before
0131     and put your passphare to a text file (~/.gnupg/dkorg-gpg-pwd.txt) 
0132 
0133     * rll.py
0134 
0135     Run by 04-build-installer.sh. It is a python script that takes a list of binaries
0136     and libraries supplied by 04-build-installer.sh and recursively lists the dlls on
0137     which they depend, and their dependencies, etc...
0138     Adapted with minimal modification (mostly deleting stuff) from
0139     https://github.com/mpreisler/mingw-bundledlls
0140 
0141     * makeall.sh
0142 
0143     This script permit to build whole 64 bits installers from scratch.
0144 
0145     * update.sh
0146 
0147     This script re-build only digiKam and installers 64 bits.
0148 
0149 * LICENSES
0150 
0151     The scripts and other contents of this package are licensed
0152     under the GNU General Public License version 2, or any later version.