INSTALL.md

Installation

See "Packages and installers" section in README.md or README.html.

Build from sources

Build dependencies

• compiler with C++17 support
• ccache (optional)
• cmake >= 3.10.0
• Qt >= 5.9.0 && Qt < 6.0
• QtWebKit (optional)
• QtWebEngine (optional)
• QCA (from upstream or from our fork)
• QtKeychain (optional)
• OpenSSL (required)
• zlib (required)
• Minizip (optional)
• Hunspell (optional)
• Aspell (optional)
• Enchant (optional)
• X11 (optional, Linux only)
• Xscreensaver (optional, Linux only)
• Sparkle (optional, macOS only)
• Growl (optional, macOS only)
• libhttp-parser (optional, for plugins only)
• libotr (optional, for plugins only)
• libtidy (optional, for plugins only)
• libomemo-c (optional, for plugins only)

Common

mkdir builddir
cd builddir
cmake ..
# If necessary install all missed build dependencies until previous command is
# executed without errors.
make -j4
make install DESTDIR="../installdir"
# If necessary replace "../installdir" from command above to any path you need
# or copy them manually from "../installdir".

Available configuration options for cmake are described in Readme-cmake.txt.

Linux

Debian based

General build dependencies:

sudo apt install -qq \
        libhunspell-dev \
        libminizip-dev \
        libqca-qt5-2-dev \
        libqt5svg5-dev \
        libqt5webkit5-dev \
        libqt5x11extras5-dev \
        libsm-dev \
        libssl-dev \
        libxss-dev \
        qt5keychain-dev \
        qtmultimedia5-dev \
        zlib1g-dev

Plugin build dependencies:

sudo apt install -qq \
        libhttp-parser-dev \
        libotr5-dev \
        libomemo-c-dev \
        libtidy-dev

openSUSE

General build dependencies:

sudo zypper in hunspell-devel \
        libXScrnSaver-devel \
        libidn-devel \
        libgpg-error-devel \
        libproxy-devel \
        "cmake(Qt5Concurrent)" \
        "cmake(Qt5Core)" \
        "cmake(Qt5DBus)" \
        "cmake(Qt5Gui)" \
        "cmake(Qt5Keychain)" \
        "cmake(Qt5LinguistTools)" \
        "cmake(Qt5Multimedia)" \
        "cmake(Qt5PrintSupport)" \
        "cmake(Qt5Sql)" \
        "cmake(Qt5Svg)" \
        "cmake(Qt5WebEngine)" \
        "cmake(Qt5X11Extras)" \
        "cmake(Qt5Xml)" \
        "pkgconfig(qca2-qt5)"

Plugin build dependencies:

sudo zypper in libotr-devel \
        libomemo-c-devel \
        libtidy-devel

macOS

There are different ways for building program in macOS. The easiest one is build using Homebrew. See instructions in mac/build-using-homebrew.sh.

Windows

To be written...

Useful links

• Build scripts for packages in Debian: psi psi-plus
• Build scripts for package in Haiku: psi_plus
• Scripts for building of portable builds for Windows: cross-compilation-using-mxe

To be continued...