Skip to content

Build Instructions for macOS

Mark Wu edited this page May 9, 2020 · 21 revisions

Notice: Be aware that there is no official support for macOS. You can still try to build Zeal manually, but that is not guaranteed to work.

Please avoid reporting issues you encounter on macOS, unless they are also reproducible on Linux or Windows.

Prerequisites

  1. Install Xcode from the AppStore. If you installed the Xcode command line tools earlier (e.g. by installing Homebrew), run this:

    sudo xcode-select -s /Applications/Xcode.app/Contents/Developer`
  2. Install Homebrew to install/compile the dependencies and Zeal itself.

Installing Zeal from Homebrew

  1. Install Qt dependencies

    brew install qt
    brew install libarchive
  2. Compile the latest development version of Zeal from Homebrew

    brew tap markwu/personal
    brew install --HEAD zeal
  3. Zeal is now available to be run. If you want you can move it to your Applications folder (not necessary if you run it through Spotlight or Alfred):

    cp -Rp /usr/local/Cellar/zeal/*/Zeal.app ~/Applications/

Installing Zeal manually

  1. Install Libarchive dependencies and setup environment variables

    brew install qt
    brew install libarchive
    export CMAKE_PREFIX_PATH=/usr/local/opt/qt5:/usr/local/opt/libarchive
  2. ompile the latest development version of Zeal manually

    git clone git clone https://github.com/zealdocs/zeal.git
    cd zeal
    mkdir build
    cd build
    cmake ..
    make
  3. Zeal is now available to be run, you can move it to your Applications folder:

    cp -Rp (your-zeal-path)/build/bin/Zeal.app ~/Applications/

Thanks go out to markwu for providing the Homebrew formula to build Zeal. For detailed (and ongoing) discussion on building Zeal on macOS, see this issue.