yubioath-flutter/doc/Building_from_Source.adoc

== Building from source

_This document documents how to build from source for Linux/Unix. Windows and
Mac OS users should use the
https://developers.yubico.com/yubioath-desktop/Releases[installers] instead._

To build from source, you need the following tools and dependencies:

- `g++`
- `make`
- Python 3
- Qt 5 development tools, including `qmake`
- Qt QML development tools

With these installed, the build procedure is:

    $ git clone --recurse-submodules https://github.com/Yubico/yubioath-desktop.git
    $ cd yubioath-desktop
    $ qmake && make

From version 4.3.0 forward, you can also use the source tarball which now also
bundles source dependencies:

    $ wget https://developers.yubico.com/yubioath-desktop/Releases/yubioath-desktop-4.3.0.tar.gz{,.sig}
    $ gpg --verify yubioath-desktop-4.3.0.tar.gz.sig
    $ tar xf yubioath-desktop-4.3.0.tar.gz
    $ cd yubioath-desktop-4.3.0
    $ qmake && make

The runtime dependencies are:

* QML modules:
 ** https://github.com/thp/pyotherside[PyOtherSide]
 ** Qt Labs Settings
 ** Qt Quick Controls
 ** Qt Quick Dialogs
* The https://developers.yubico.com/yubikey-manager/[YubiKey Manager] Python
  library

With these installed, you can just run the program:

    $ ./yubioath-desktop


=== Packaging

The files you need to include in a distribution package are:

- The `yubioath-desktop` binary
- The icon `resources/icons/yubioath.png`, installed as `yubioath.png` somewhere
  on the
  https://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html#directory_layout[Freedesktop]
  or
  https://doc.qt.io/qt-5/appicon.html#setting-the-application-icon-on-common-linux-desktops[Qt]
  icons search path, for example as `/usr/share/pixmaps/yubioath.png`
- (Optional) The Desktop Application descriptor
  `resources/yubioath-desktop.desktop`