Synergy-Binaries/Documentation/BuildingOnDarwin.md

## Building on macOS

### Prerequisites

1. Install the following tools and dependencies:

      * [Homebrew](http://brew.sh/)
      * [Python 3](https://www.python.org/downloads/windows/)
      * [XCode](https://developer.apple.com/xcode/download/)
      * [Qt 5](https://www.qt.io/download/), select the following components:
         * Qt 5.12.9 / macOS

2. Edit the [`Scripts/config.txt`](../Scripts/config.txt) file and make sure the following variables are configured properly under the `[Darwin]` section:

      * `libQtPath` -- Full path to the Qt library, clang, 64-bit build.

3. Run the installer script to configure additional dependencies, as noted below. If you wish to examine what packages will be installed, see package lists [`PackageListBrew.txt`](../Scripts/Install/PackageListBrew.txt) and [`PackageListPython.txt`](../Scripts/Install/PackageListPython.txt).

      * If Python is already installed:
         ```sh
         ./Scripts/install.py [--upgrade]
         ```
      * If Python is not installed:
         ```sh
         ./Scripts/Install/InstallDarwin.sh [--upgrade]
         ```

      Use the `--upgrade` switch to refresh packages at a later date.

### Building

Build the project with the following Python script. Packages will be copied into the [`Binaries`](../Binaries) directory.

```sh
./Scripts/build.py
```

Similarly, one can clean the project, which resets Git repositories to a clean state:

```sh
./Scripts/clean.py
```