You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update mac build doc to reflect main branch: Qt6+VFX CY2024 (#770)
### Update macOS build instructions to reflect main branch: Qt6+VFX
CY2024
### Linked issues
NA
### Summarize your change.
This commit updates the the macOS build instructions to reflect main
branch: Qt6+VFX CY2024
### Describe the reason for the change.
Build instructions were stale
### Describe what you have tested and on which operating system.
### Add a list of changes, and note any that might need special
attention during the review.
### If possible, provide screenshots.
Signed-off-by: Bernard Laberge <bernard.laberge@autodesk.com>
Copy file name to clipboardExpand all lines: docs/build_system/config_macos.md
+19-156
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,17 @@
5
5
6
6
-[Summary](summary)
7
7
-[Allow Terminal to update or delete other applications](allow_terminal)
8
-
-[Install XCode](install_xcode)
8
+
-[Install Xcode](install_xcode)
9
9
-[Install Homebrew](install_homebrew)
10
10
-[Install tools and build dependencies](install_tools_and_build_dependencies)
11
11
-[Install Qt](install_qt)
12
12
-[Build Open RV](build_openrv)
13
13
14
-
````{warning}
15
-
**Qt Open Source version 5.15.2** is the latest with publicly available binaries, but it lacks *arm64* libraries.
16
-
Therefore, OpenRV builds using **Qt 5.15.2** are limited to *x86_64* architecture. To build natively on *arm64*, you will
17
-
have to build a recent version of Qt 5 from source or use the commercial version.
18
-
19
-
See [Qt](install_qt) section for more information
20
-
````
21
-
22
14
````{note}
23
-
OpenRV can be build for *x86_64* by changing the architecture of the terminal to *x86_64* with the following command:
15
+
OpenRV can be built for *x86_64* by changing the architecture of the terminal to *x86_64* using the following command:
16
+
```bash
17
+
arch -x86_64 $SHELL
18
+
```
24
19
````arch -x86_64 $SHELL````
25
20
26
21
**It is important to use that *x86_64* terminal for all the subsequent steps.**
@@ -29,28 +24,21 @@ OpenRV can be build for *x86_64* by changing the architecture of the terminal to
29
24
(allow_terminal)=
30
25
## Allow Terminal to update or delete other applications
31
26
32
-
From the macOS System Settings/Privacy & Security/App Management, allow Terminal to update or delete other applications.
27
+
From macOS System Settings > Privacy & Security > App Management, allow Terminal to update or delete other applications.
33
28
34
29
(install_xcode)=
35
-
## Install XCode
30
+
## Install Xcode
36
31
37
-
From the App Store, download XCode 14.3.1. Make sure that it's the source of the active developer directory.
38
-
Note that using an XCode version more recent than 14.3.1 will result in an FFmpeg build break.
32
+
From the App Store, download Xcode. Make sure that it is the source of the active developer directory.
39
33
40
-
`xcode-select -p` should return `/Applications/Xcode.app/Contents/Developer`. If it's not the case, run `sudo xcode-select -s /Applications/Xcode.app`
41
-
42
-
Note that XCode 15 is not compatible with Boost 1.80. If XCode 15 is installed, RV will automatically default to using Boost 1.81 instead.
43
-
Install XCode 14.3.1 if you absolutely want to use Boost version 1.80 as per VFX reference platform CY2023.
44
-
45
-
Please reference [this workaround](https://forums.developer.apple.com/forums/thread/734709) to use XCode 14.3.1 on Sonoma, as it is no longer
46
-
compatible by default.
34
+
`xcode-select -p` should return `/Applications/Xcode.app/Contents/Developer`. If that is not the case, run `sudo xcode-select -s /Applications/Xcode.app`
47
35
48
36
(install_homebrew)=
49
37
## Install Homebrew
50
38
51
-
Homebrew is the onestop shop providing all the build requirements. You can install it following the instructions on the [Homebrew page](https://brew.sh).
39
+
Homebrew is the one-stop shop providing all the build requirements. You can install it by following the instructions on the [Homebrew page](https://brew.sh).
52
40
53
-
Make sure Homebrew's binary directory is in your PATH and that `brew`is resolved from your terminal.
41
+
Make sure Homebrew's binary directory is in your PATH and that `brew`can be resolved from your terminal.
54
42
55
43
(install_tools_and_build_dependencies)=
56
44
## Install tools and build dependencies
@@ -61,147 +49,22 @@ Most of the build requirements can be installed by running the following brew in
Make sure `python` resolves in your terminal. In some case, depending on how the python formula is built, there's no `python` symbolic link.
52
+
Make sure `python` resolves in your terminal. In some cases, depending on how the python formula is built, there is no `python` symbolic link.
65
53
In that case, you can create one with this command `ln -s python3 $(dirname $(which python3))/python`.
66
54
67
55
(install_qt)=
68
56
## Install Qt
69
57
70
-
````{warning}
71
-
For arm64, Qt must be compiled from source because the latest version is needed. Qt 5.15.2 does not have arm64 support.
72
-
73
-
For x86_64, Qt 5.15.2 can be used - but OpenRV must be built within a x86_64 terminal. You can change the architecture
74
-
of the terminal with this command: ````arch -x86_64 $SHELL````
75
-
76
-
````
77
-
78
-
Download the last version of Qt 5.15.x that you can get using the online installer on the [Qt page](https://www.qt.io/download-open-source). Logs, Android, iOS and WebAssembly are not required to build OpenRV.
79
-
80
-
81
-
WARNING: If you fetch Qt from another source, make sure to build it with SSL support, that it contains everything required to build PySide2, and that the file structure is similar to the official package.
82
-
83
-
Note: Qt5 from homebrew is known to not work well with OpenRV.
84
-
85
-
86
-
### Quick guide to build Qt from source
87
-
88
-
````{warning}
89
-
If you really do not need a arm64 build, it is **recommended** to build OpenRV for **x86_64** and use **Qt 5.15.2**. \
90
-
\
91
-
Building Qt from source is **difficult** even for developpers, and takes some times depending on your machine.
92
-
````
93
-
94
-
````{note}
95
-
The quick guide provided here is based
96
-
on the [OpenRV GitHub Action workflow](https://github.com/AcademySoftwareFoundation/OpenRV/blob/main/.github/actions/build-qt5-for-arm64/action.yml) that OpenRV uses to build Qt from source for
97
-
arm64.
98
-
99
-
Quick list of the dependencies: \
100
-
XCode 14, homebrew and a multiple of packages, Ninja 1.11.1, Python2 and Python3.
101
-
````
102
-
103
-
Here is the quick guide on how to build the latest Qt for arm64:
104
-
````bash
105
-
# Adapt the version for the XCode present on your machine.
Download the last version of Qt 6.5.x using the online installer on the [Qt page](https://www.qt.io/download-open-source). Qt logs, Android, iOS, and WebAssembly are not required to build OpenRV.
125
59
126
-
````bash
127
-
# Install and use pyenv to manage python2 and python3.
WARNING: If you fetch Qt from another source, make sure it is built with SSL support, contains everything required to build PySide6, and that the file structure is similar to the official package.
136
62
137
-
````bash
138
-
# Download Qt 5.15.15 source. A more recent version can be used as well.
0 commit comments