Debian Codegraph @

project/bundles/homebrew/README

raw
1 RESUME
2 ------
3 Scripts to build binary digiKam package for MacOS
4
5 These scripts build a binary digiKam package for MacOS using HomeBrew
6 environment and Packages application.
7
8 ** NOTE ** The official digiKam MacOS packages are built with Macports. The Homebrew bundle is experimental,
9 and may have additional issues not found with the Macports bundle. The benefit of the Homebrew bundle is it is
10 significantly faster to build from scratch than Macports.
11
12 These scripts follow instructions from Qt bundle deployment for MacOS as shared libraries
13 available at this url: https://doc.qt.io/qt-6/macos-deployment.html
14
15 Current known issues with Homebrew bundle:
16 * Functionality:
17 * General - Unable to play multimedia files
18 * DB - MariaDB works as initial DB, but unable to use migration tool to MariaDB
19 * UI:
20 * Unable to use Breeze icon set
21 * digiKam icon changes to plain icon after loading
22
23
24 AUTHORS
25 -------
26
27 (c) 2015 by Shanti <listaccount at revenant dot org>
28 (c) 2015-2026 by Gilles Caulier <caulier dot gilles at gmail dot com>
29 (c) 2024-2025 by Michael Miller <michael underscore miller at msn dot com>
30
31
32 DESCRIPTION
33 -----------
34 These files and scripts are used to make a binary package of the digiKam
35 Software Collection for MacOS. In addition to this README, there are
36 comments in the scripts that provide some additional explanations for
37 how they work.
38
39
40 BUNDLE CONTENTS
41 ---------------
42
43 Note: the bundle is relocatable.
44
45 Bundle is composed of two main application containers (digikam and showfoto), to start from the macOS lauchpad.
46 The digikam sub-container include all resources shared with showfoto.
47 The showfoto sub-container directories are linked to the digikam sub-container to reduce used-space.
48 The host directory is called "digiKam.org" and not "digiKam" to allow Showfoto icon to be show on macOS lauchpad,
49 else only digiKam is visible.
50
51 digiKam.org
52 ├── digikam.app digiKam sub-container
53 │ └── Contents
54 │ ├── bin Extra binaries
55 │ ├── etc Extra configuration
56 │ ├── lib Libraries and extra dependencies
57 │ ├── libexec Run time dependencies
58 │ │ └── qt5
59 │ │ ├── lib
60 │ │ └── plugins Plugins
61 │ │ ├── bearer
62 │ │ ├── designer
63 │ │ ├── digikam digiKam and Showfoto DPlugins
64 │ │ │ ├── bqm
65 │ │ │ ├── dimg
66 │ │ │ ├── editor
67 │ │ │ ├── generic
68 │ │ │ └── rawimport
69 │ │ ├── generic
70 │ │ ├── iconengines
71 │ │ ├── imageformats
72 │ │ ├── kauth
73 │ │ ├── kf5
74 │ │ ├── platforms
75 │ │ ├── platformthemes
76 │ │ ├── printsupport
77 │ │ ├── sqldrivers
78 │ │ └── styles
79 │ ├── MacOS digiKam binary
80 │ ├── Resources Data and resource files
81 │ │ ├── applications
82 │ │ ├── data
83 │ │ ├── digikam
84 │ │ ├── kf5
85 │ │ ├── knotifications5
86 │ │ ├── kservices5
87 │ │ ├── kservicetypes5
88 │ │ ├── kxmlgui5
89 │ │ ├── lensfun Lens auto correction profiles
90 │ │ ├── locale
91 │ │ ├── mime
92 │ │ ├── opencv4
93 │ │ ├── plugins
94 │ │ ├── showfoto
95 │ │ └── solid
96 │ └── share Shared files
97 └── showfoto.app Showfoto sub-container
98 └── Contents
99 ├── bin -> ../../digikam.app/Contents/bin
100 ├── etc -> ../../digikam.app/Contents/etc
101 ├── lib -> ../../digikam.app/Contents/lib
102 ├── libexec -> ../../digikam.app/Contents/libexec
103 ├── MacOS Showfoto binary
104 ├── Resources -> ../../digikam.app/Contents/Resources
105 └── share -> ../../digikam.app/Contents/share
106
107 REQUIREMENTS
108 ------------
109
110 To build bundle you need a macOS install in a real computer (best) or in a VM.
111 This Github project have been tested to install automatically BigSur in VirtualBox and work as expected:
112
113 https://github.com/myspaghetti/macos-virtualbox
114
115 The scripts build digiKam with HomeBrew, so you will need Xcode and the other
116 prerequisites for HomeBrew.
117
118 See this url for details: https://docs.brew.sh/Xcode.
119
120 For all other HomeBrew requirements, see https://docs.brew.sh/Installation.
121
122 You will also need to install Packages software which does the actual packaging of the files needed to install digiKam:
123
124 http://s.sudre.free.fr/Software/Packages/about.html
125
126 IMPORTANT:
127 - You must set the minimal MacOS target with relevant SDK installed for backward compatibility.
128 - You must set the digiKam git tags to checkout right source code to package.
129 - You must set the option to host debug symbols or not in package.
130
131 NOTE: Look in config.sh file for settings details.
132
133
134 HERE THERE BE DRAGONS
135 ---------------------
136 Use these scripts at your own risk. For example, both scripts contain
137 "rm -rf" (to clear previous builds) -- a mistake could wipe your drive.
138
139
140 COMPONENTS
141 ----------
142 There are 4 main scripts to be run by the user. 2 first ones installs
143 HomeBrew and all dependencies, next one digiKam, and last one makes a
144 PKG binary installer for MacOS using Packages.
145
146
147 SCRIPT DESCRIPTIONS
148 -------------------
149 All scripts should be run from within the digikam-package directory.
150
151 * 01-build-homebrew.sh:
152
153 This script downloads and configures a custom non-root install
154 of HomeBrew to /opt/homebrew.
155
156 * 02-build-extralibs.sh:
157
158 This script configures, and compile a custom non-root install to /opt/homebrew
159 of extra libraries, including KF6 frameworks, and most important photo management
160 libs used by digiKam as Exiv2 and LensFun.
161
162 * 03-build-digikam.sh:
163
164 This script configures, and compile a custom non-root install of digiKam to
165 /opt/homebrew.
166
167 * 04-build-installer.sh:
168
169 Once you've successfully built digiKam, /opt/homebrew may contain over 10GB of files.
170 This script grabs the ~250MB needed to run digiKam and Showfoto,
171 and places them in ./installer/opt. These include applications documentations
172 and translations.
173
174 This script creates Applescript launch applications for the programs that will
175 be run by the user (digiKam, Showfoto, etc), and preinstall/postinstall
176 scripts in ./installer.
177
178 The launcher applications:
179 1) Update desktop.org files cache system with kbuildsyscoca5.
180 2) set "DYLD_IMAGE_SUFFIX=_debug" if the digikam port was built with the
181 +debug variant.
182
183 This script also create the pre-install and post-install scripts that are run
184 when the package is installed. They delete any pre-existing /opt/homebrew,
185 delete and recreate /Applications/digiKam.org.
186
187 Finally, this script sets the version number, and runs Packages to
188 put everything together in the bundle.
189
190 Depending of configuration done in config.sh, this script is able to upload automatically
191 the bundle file on files.kde.org digiKam area through ssh. A valid ssh key configured
192 with remote KDE server need to be set previously with the account. You can load ssh key
193 at startup following instruction give at this url:
194
195 https://unix.stackexchange.com/questions/90853/how-can-i-run-ssh-add-automatically-without-password-prompt
196
197 Note: the bundle can be signed with GPG. You must setup your private and public keys before
198 and put your passphare to a text file (~/.gnupg/dkorg-gpg-pwd.txt)
199
200 * rll.py
201
202 Run by 04-build-installer.sh. It is a Python script that takes a list of binaries
203 and libraries supplied by 04-build-installer.sh and recursively lists the dylibs on
204 which they depend, and their dependencies, etc.. Adapted with minimal
205 modification (mostly deleting stuff) from
206 https://github.com/mixxxdj/mixxx/blob/master/build/osx/otool.py.
207
208 * makeall.sh
209
210 This script permit to build whole package from scratch (all stages).
211
212 * update.sh
213
214 This script re-build only digiKam and package (2 last stages).
215
216
217 LICENSES
218 --------
219 rll.py, like the otool.py source from which it has been adapted, is licensed
220 under GNU General Public License version 2.
221
222 The scripts and other contents that we have created are licensed
223 under the GNU General Public License version 2, or any later version.