4 **jack_mixer** uses [meson] and optionally a Python [PEP-517]-compliant build
5 system for building, installation and packaging.
12 * GCC (version 9.x or 10.x recommended, package `build-essential` on Debian/Ubuntu)
15 * Python headers (`python3-dev`)
16 * [JACK] headers (`libjack-jackd2-dev` (recommended) or `libjack-dev`)
17 * glib2 headers (`libglib2.0-dev`)
18 * [Cython] (optional, required if building from a Git checkout)
19 * [docutils] (optional, `rst2man` required if building from a Git checkout)
23 * Python (at least 3.6)
26 * `libjack` and JACK server (`jackd2` (recommended) or `jackd`)
28 Optional run-time dependencies:
30 * [pyxdg] - For saving your preferences (strongly recommended)
31 * [NSM] - For NSM session management support
33 The run-time Python dependencies are checked by meson when setting up the
34 build directory. To disable this, use the `-Dcheck-py-modules=false` option to
40 Building with meson always happens in a special build directory. Set up the
41 build in the `builddir` sub-directory and configure the build with:
44 meson setup builddir --prefix=/usr --buildtype=release
47 Then build the software with:
50 meson compile -C builddir
57 [sudo] meson install -C builddir
60 **Note for packagers**: to install all files under a destination directory
61 other than the filesystem root, set the `DESTDIR` environment variable for
67 DESTDIR="/tmp/jack_mixer-install-root" meson install -C builddir
73 There are several project-specific [options] to configure the build and the
74 resulting installation. To see all supported options (including [standard
75 meson options]) and their possible values run:
81 If you have already set up the build directory, you can append its name
82 to see the current values of all options for this build configuration.
84 To change an option, pass the build directory and `-Doption=value` to
85 `meson setup` or `meson configure`. For example:
88 meson configure builddir -Dgui=disabled
92 ## Building a Python wheel (for maintainers)
94 1. Make sure you have Python 3, `git` and [pip] installed and your internet
96 2. Run the following command to build a binary wheel:
102 This will automatically download the required build tools, e.g. Cython, meson,
103 ninja, the Python `wheel` package etc. (see the [pyproject.toml] file for
104 details), build the software with meson and then package it into a wheel, which
105 will be placed in the project's root directory.
107 The wheel can be installed with `pip install jack_mixer-*.whl`.
110 [docutils]: https://pypi.org/project/docutils/
111 [Cython]: https://cython.org/
112 [JACK]: https://jackaudio.org/
113 [meson]: https://mesonbuild.com/
114 [ninja]: https://ninja-build.org/
115 [NSM]: https://github.com/linuxaudio/new-session-manager
116 [options]: https://mesonbuild.com/Build-options.html
117 [pip]: https://pypi.org/project/pip/
118 [pycairo]: https://pypi.org/project/pycairo/
119 [PyGObject]: https://pypi.org/project/PyGObject/
120 [pyxdg]: https://freedesktop.org/wiki/Software/pyxdg/
121 [PEP-517]: https://www.python.org/dev/peps/pep-0517/
122 [pyproject.toml]: ./pyproject.toml
123 [standard meson options]: https://mesonbuild.com/Builtin-options.html