mirror of
https://gitlab.com/pholy/OSCAR-code.git
synced 2025-04-04 18:20:42 +00:00
93 lines
4.3 KiB
Markdown
93 lines
4.3 KiB
Markdown
# OSCAR Build Instructions for Mac
|
|
|
|
## Prerequisites
|
|
|
|
- [Qt 5.12.8] (the current LTS release as of OSCAR 1.1.0)
|
|
- [macOS 10.12 Sierra] or higher for building (required by Qt 5.12)
|
|
- Command-Line Tools for Xcode 9.2, and optionally [Xcode] itself
|
|
- Xcode 9.2 is the last version that runs on macOS 10.12
|
|
- Xcode 10.1 is the last version that runs on macOS 10.13
|
|
- Xcode 10.3 is the latest version that runs on macOS 10.14
|
|
|
|
NOTE: Official builds are currently made with [macOS 10.14 Mojave] and Command-Line Tools for [Xcode] 10.3.
|
|
|
|
## Setup
|
|
1. Install Mac OS X 10.12.6 Sierra (or later) and apply all updates.
|
|
* Optionally create a "build" user.
|
|
|
|
2. (Optional) Install Xcode 9.2 (or later, if using a newer version of macOS), approx. 7GB:
|
|
1. Open Xcode_9.2.xip to expand it with Archive Utility. This will take a while.
|
|
2. Delete the .xip archive.
|
|
3. Move Xcode.app into /Applications.
|
|
4. Launch Xcode.app and agree to the license.
|
|
5. Uncheck "Show this window..." and close the window.
|
|
6. Xcode > Quit
|
|
|
|
3. Install the command-line developer tools, approx. 0.6GB:
|
|
|
|
1. Launch Terminal.app and run:
|
|
|
|
xcode-select --install
|
|
|
|
2. Click "Install".
|
|
3. Click "Agree".
|
|
|
|
This will download and install the latest version of the Command-Line Tools for Xcode for your version of macOS, without requiring a developer account.
|
|
|
|
_Alternatively, the command-line tools installer .dmg can be downloaded from the [Xcode] download site, but you will need a (free) developer account and will
|
|
need to pick the appropriate download for your version of macOS._
|
|
|
|
4. Install Qt (as "build" user, if created), approx. 3GB:
|
|
1. Mount qt-opensource-mac-x64-5.12.8.dmg
|
|
2. Launch qt-opensource-mac-x64-5.12.8
|
|
3. Next, Skip, Continue, (optionally change the installation directory), Continue
|
|
* Qt is entirely self-contained and can be installed anywhere. It defaults to ~/Qt5.12.8.
|
|
* If you only have the command-line tools installed, the Qt installer will complain that "You need to install Xcode and set up Xcode command line tools." Simply click OK.
|
|
4. Expand Qt 5.12.8 and select "macOS", Continue
|
|
5. Select "I have read and agree..." and Continue, Install
|
|
6. Uncheck "Launch Qt Creator", Done
|
|
7. Eject qt-opensource-mac-x64-5.12.8
|
|
|
|
## Build
|
|
|
|
1. Build OSCAR:
|
|
|
|
git clone https://gitlab.com/CrimsonNape/OSCAR-code.git
|
|
cd OSCAR-code
|
|
mkdir build
|
|
cd build
|
|
~/Qt5.12.8/5.12.8/clang_64/bin/qmake ../oscar/oscar.pro
|
|
make
|
|
|
|
The application is in OSCAR.app.
|
|
|
|
2. (Optional) Package for distribution:
|
|
|
|
make dist-mac
|
|
|
|
The dmg is at OSCAR.dmg.
|
|
|
|
## (Optional) Using Qt Creator
|
|
|
|
1. Launch Qt Creator where you installed Qt above, by default ~/Qt5.12.8/Qt Creator.app.
|
|
2. File > Open File or Project... and select ~/OSCAR-code/oscar/oscar.pro (or wherever you cloned it above), then click "Configure Project".
|
|
3. Configure building:
|
|
1. Click on "Projects" in the left panel.
|
|
2. Under **Build Settings**, in the "Edit build configuration" drop-down menu, select "Release".
|
|
3. Click to expand "Details" for the **qmake** build step.
|
|
4. Uncheck "Enable Qt Quick Compiler", click "No" to defer recompiling.
|
|
4. Configure packaging for distribution:
|
|
1. Click "Clone..." to the right of the "Edit build configuration" drop-down menu.
|
|
2. Name the new configuration "Deploy".
|
|
3. Click to expand "Details" for the **Make** build step.
|
|
4. Set the Make arguments for the Make step to "dist-mac".
|
|
5. To build OSCAR, select "Release" from the "oscar" button in the left panel. Then select Build > Build Project "oscar". The application is in OSCAR.app.
|
|
6. To build OSCAR and package for distribution, select "Deploy" from the "oscar" button in the left panel. Then select Build > Build Project "oscar". The dmg is at OSCAR.dmg.
|
|
* Progress in "Compile Output" will pause for several seconds while "Creating .dmg". This is normal.
|
|
|
|
[Qt 5.12.8]: http://download.qt.io/archive/qt/5.12/5.12.8/qt-opensource-mac-x64-5.12.8.dmg
|
|
[macOS 10.14 Mojave]: https://apps.apple.com/us/app/macos-mojave/id1398502828?ls=1&mt=12
|
|
[macOS 10.13 High Sierra]: https://apps.apple.com/us/app/macos-high-sierra/id1246284741?ls=1&mt=12
|
|
[macOS 10.12 Sierra]: https://apps.apple.com/us/app/macos-sierra/id1127487414?ls=1&mt=12
|
|
[Xcode]: https://developer.apple.com/download/more/
|