Updated Build Instructions for macOS (markdown)

Kian Mayne 2019-08-30 15:46:29 +01:00
parent d462a243aa
commit d967f4857d

@ -2,67 +2,16 @@
Please avoid reporting issues you encounter on macOS, unless they are also reproducible on Linux or Windows.
# [@markwu Homebrew Formula](https://github.com/markwu/homebrew-personal/blob/master/Formula/zeal.rb)
This Homebrew formula has been kindly provided by @markwu. To install run
```
brew tap markwu/personal
brew install zeal
```
Note installing the qt5-webkit package may take some time.
# Manual Build
## Installing dependencies
Use one of the following methods, based on which package manager you use.
#### Homebrew
```bash
brew install qt@5.5 libarchive
You will need to install cmake, libarchive, qt, qt5-webkit (available as a Homebrew formula on the markwu/personal tap).
```
You may choose to link `qt`, as the brew formula is 'keg-only', which avoids writing the full path to the `qmake` executable below. You may do so by:
```bash
brew link qt@5.5 --force
```
#### MacPorts
```bash
port install qt5 qt5-qtwebengine qt5-sqlite-plugin libarchive
```
## Building Zeal
### Source code
To test the most recent version of source code, fetch it from GitHub:
```bash
git clone https://github.com/zealdocs/zeal.git
```
### Compiling
#### Homebrew
Replace the full path to `qmake` with just the name of the command, if you linked `qt` as described above.
```bash
/usr/local/Cellar/qt@5.5/5.5.1_1/bin/qmake INCLUDEPATH+=/usr/local/opt/libarchive/include
make SUBLIBS="-L/usr/local/opt/libarchive/lib -larchive -lsqlite3"
```
#### MacPorts
```bash
/opt/local/libexec/qt5/bin/qmake INCLUDEPATH+=/opt/local/include
make SUBLIBS="-L/opt/local/lib -larchive -lsqlite3"
```
### Appbundle
Create an application bundle:
```bash
cd bin
/opt/local/libexec/qt5/bin/macdeployqt Zeal.app
```
#### Homebrew
Create an application bundle:
Replace the full path to `macdeployqt` with just the name of the command, if you linked `qt` as described above.
```` bash
cd bin
/usr/local/Cellar/qt@5.5/5.5.1_1/bin/macdeployqt Zeal.app
````
## Installation
Simply move `Zeal.app` to your `Applications` directory.