# Installation

## Pre-built Binaries

You can find the latest pre-built binaries of sioyek here: https://github.com/ahrm/sioyek/releases

## Homebrew Cask

There is a homebrew cask available here: https://formulae.brew.sh/cask/sioyek. Install by running:

    brew install --cask sioyek

## Third-party packages for Linux

If you prefer to install sioyek with a package manager, you can look at this list. Please note that they are provided by third party packagers. USE AT YOUR OWN RISK! If you’re reporting a bug for a thrid-party package, please mention which package you’re using.

Distro | Link
--- | ---
Flathub | https://flathub.org/apps/details/com.github.ahrm.sioyek
Alpine | https://pkgs.alpinelinux.org/packages?name=sioyek
AUR Sioyek-git | https://aur.archlinux.org/packages/sioyek-git/
AUR sioyek-appimage | https://aur.archlinux.org/packages/sioyek-appimage/
NixOS | https://search.nixos.org/packages?channel=unstable&show=sioyek&from=0&size=50&sort=relevance&type=packages&query=sioyek

## Building from source

### Linux

1. Install Qt 5 and make sure qmake is in `PATH`.

2. Install `libharfbuzz`:

    $ apt install libharfbuzz-dev

3. Clone the repository and build:

    $ git clone --recursive https://github.com/ahrm/sioyek
    $ cd sioyek
    $ ./build_linux.sh

### Windows

1. Install Visual Studio (tested on 2019, other relatively recent versions should work too)

2. Install Qt 5 and make sure qmake is in `PATH`.

3. Clone the repository and build using 64 bit Visual Studio Developer Commnand Prompt:

    $ git clone --recursive https://github.com/ahrm/sioyek
    $ cd sioyek
    $ build_windows.bat

### Mac

1. Install Xcode and Qt 5.

2. Clone the repository and build:

    $ git clone --recursive https://github.com/ahrm/sioyek
    $ cd sioyek
    $ chmod +x build_mac.sh
    $ ./build_mac.sh