Update cmakelists, and documentation for building on OSX. #27
Conversation
Users often install qt or other libraries on mac via homebrew. Because other installs of qt may exist, these may not be under the default prefix for CMake. This ensures that Qt is found properly in those cases.
This was a bit incomplete when I went through this process for High Sierra.
| @@ -28,7 +28,9 @@ The manual for Dwarf Therapist can be downloaded separately. | |||
| Building | |||
| ======== | |||
|
|
|||
| Dwarf-Therapist requires a C++ compiler (with C++14 support), cmake (3.1.0 or newer), and Qt5 (with Widgets and QML modules). | |||
| Dwarf-Therapist requires a C++ compiler (with C++14 support), cmake (3.1.0 or newer), and Qt5.5 (with Widgets and QML modules). | |||
There was a problem hiding this comment.
Qt 5.5 is not required. Any Qt 5 version should work. If DT use some features that was added during the Qt 5 cycle, it should be "Qt 5.x or newer". I have built DT on Ubuntu Trusty with Qt 5.2 so it is at least that.
| # On Mac, Homebrew installs this version in /usr/local/opt/qt@5.5 | ||
| # without this it looks in the usual /usr/local prefix. | ||
| # this must occur before the find_package call below | ||
| list(APPEND CMAKE_PREFIX_PATH "/usr/local/opt/qt@5.5") |
There was a problem hiding this comment.
I would prefer adding in the building instructions: "use -DCMAKE_PREFIX_PATH=/usr/local/opt/qt@5.5" rather than hard-coding paths in cmakelists. If Qt is installed any other way, that will break.
Travis uses "CMAKE_PREFIX_PATH=/usr/local/opt/qt" without the version number.
There was a problem hiding this comment.
So, I'm not familiar with cmake, I don't use it on the reg. Would you be fine if this path didn't include the version number + the instructions indicated that it can be overridden? Or are you suggesting something else? I did first try this as an environment variable to no avail.
There was a problem hiding this comment.
I was suggesting to not change CMakeLists.txt and write something in the building instructions like:
brew install qt@5.5
export CMAKE_PREFIX_PATH=/usr/local/opt/qt@5.5
...
Would you be fine if this path didn't include the version number?
It would be fine if it was a standard location. If you install qt@5.x (specifying a version number), will /usr/local/opt/qt work? If it is too hard to predict where qt-sdk is installed. I think it would be better for the user to set it explicitly, this way it is easier for the user to adapt the value if cmake fails to find Qt.
| Dwarf-Therapist requires a C++ compiler (with C++14 support), cmake (3.1.0 or newer), and Qt5 (with Widgets and QML modules). | ||
| Dwarf-Therapist requires a C++ compiler (with C++14 support), cmake (3.1.0 or newer), and Qt5.5 (with Widgets and QML modules). | ||
|
|
||
| For All Users: |
There was a problem hiding this comment.
I think it would be better with some kind of formatting, to make the distinction between sections (all/linux/mac) clearer: bold or low level title.
|
|
||
| brew install qt@5.5 | ||
| brew install cmake | ||
| brew cask install basictex |
There was a problem hiding this comment.
If you want to build the manual, you need to add -DBUILD_MANUAL=ON in cmake parameters. Is basictex enough? On fedora I need: texlive-bibtex, texlive-cm, texlive-latex-bin, texlive-makeindex, texlive-mfware, texlive-preprint, texlive-sidecap, texlive-wrapfig.
|
|
||
| After running make, do the following:: | ||
|
|
||
| mv build/Dwarf-Therapist.app ~/Applications |
There was a problem hiding this comment.
This installs only the executable, right? The memory layouts should be copied too, and the manual if you built it.
|
It is not finished yet but I created PR #31 so you can see how BUILDING.rst content could look like. The plan is to move your instructions in the "macOS" section. |
cvuchener
force-pushed
the
master
branch
3 times, most recently
from
821a644
to
33b1faa
Compare
|
This pull request has been inactive for too long. I merged #50. If you want to improve the OSX instructions, create a new pull request based on the new changes (with BUILDING.md). |
Some of this was sourced from #23.
I ran into some issues with homebrew and tex, so I thought I'd make the changes I made to get past them available for others.