1.. SPDX-FileCopyrightText: © 2019-2022 Alexandros Theodotou <alex at zrythm dot org>
2.. SPDX-License-Identifier: FSFAP
4Installation Instructions
5=========================
13You will need the GNU toolchain, a C/C++ compiler
16`meson (Apache-2.0) <https://mesonbuild.com/>`_
19`guile (GPLv3+) <https://www.gnu.org/software/guile/>`_
20 Used in various build scripts
22`sassc (Expat) <https://github.com/sass/sassc>`_
25`lilv (ISC) <https://drobilla.net/software/lilv>`_
26 LV2 plugin hosting library used in tests only
28.. `blueprint-compiler (LGPLv3+) <https://gitlab.gnome.org/jwestman/blueprint-compiler>`_
31If your meson version is too old, you can either
33`pip <https://pypi.org/project/pip/>`_
34or run ``meson.py`` directly from
35`meson's source code <https://github.com/mesonbuild/meson>`_.
40The following dependencies must be installed before
41attempting to build or run Zrythm.
46`carla (GPLv2+) <https://kx.studio/Applications:Carla>`_
47 Support for various plugin formats
49`fftw (GPLv2+) <http://www.fftw.org/>`_
50 Threaded fftw for plugins
52`gtk4 (LGPLv2.1+) <https://gtk.org/>`_
55`gtksourceview (LGPLv2.1+) <https://wiki.gnome.org/Projects/GtkSourceView>`_
56 Source code editor widget
58`libadwaita (LGPLv2.1+) <https://gitlab.gnome.org/GNOME/libadwaita>`_
61`libbacktrace (3-Clause BSD) <https://github.com/ianlancetaylor/libbacktrace>`_
64`libcurl (X11) <https://curl.se/libcurl/>`_
67`libpanel (LGPLv3+) <https://gitlab.gnome.org/chergert/libpanel/>`_
68 Dock and panel widgets
70Note: if you want detach support use `our fork <https://gitlab.zrythm.org/zrythm/libpanel-detach>`_ (``zrythm_detach`` branch).
72`libsndfile (LGPLv2.1+) <http://libsndfile.github.io/libsndfile/>`_
75`pcre2 (3-Clause BSD) <https://www.pcre.org/>`_
78`rubberband (GPLv2+) <https://breakfastquay.com/rubberband/>`_
79 Time-stretching and pitch-shifting
81`soxr (LGPLv2.1+) <https://sourceforge.net/projects/soxr/>`_
84`vamp-plugin-sdk (X11) <https://vamp-plugins.org/>`_
87`xxhash (2-Clause BSD) <https://cyan4973.github.io/xxHash/>`_
90`yyjson (MIT) <https://github.com/ibireme/yyjson>`_
93`zix (ISC) <https://github.com/drobilla/zix>`_
94 Portability wrappers and data structures
96`zstd (3-Clause BSD) <https://github.com/facebook/zstd>`_
102`boost (Boost) <https://www.boost.org/>`_
103 C++ utilities required for building the bundled plugins
105`jack (LGPLv2.1+) <https://jackaudio.org/>`_
106 Low latency audio/MIDI backend
108`lsp-dsp-lib (LGPLv3+) <https://github.com/sadko4u/lsp-dsp-lib>`_
109 SIMD-optimized signal processing
111`rtaudio (Expat) <http://www.music.mcgill.ca/~gary/rtaudio/>`_
112 Various audio backends
114`rtmidi (Expat) <https://www.music.mcgill.ca/~gary/rtmidi/>`_
115 Various MIDI backends
120`graphviz (EPLv1.0) <http://graphviz.org/>`_
121 Process graph export (only used for debugging)
123`libcyaml (ISC) <https://github.com/tlsa/libcyaml/>`_
124 Serialization into YAML (only needed to upgrade old projects created before `v1.0.0-beta.5.0`)
129`SDL2 (zlib) <https://www.libsdl.org/>`_
135Configure the build directory, optionally passing options::
137 meson setup build -Doption_name=value
139To see all available options, type the following
140after the build directory is initialized, or look
141inside `meson_options.txt <meson_options.txt>`_.
142Built-in meson options can be found
143`here <https://mesonbuild.com/Builtin-options.html>`_::
145 meson configure build
147To change an option after configuration, use::
149 meson configure build -Doption_name=value
151To change environment variables (such as ``CC`` and
152``CXX``) while keeping the current configuration, use::
154 MY_ENV_VARIABLE=myvalue meson build --wipe
156To start from scratch, remove the ``build`` directory::
163The default build type is ``debugoptmized``, which
164is equivalent to ``-Ddebug=true -Doptimization=2``
165(``-O2 -g``). This works well in most cases. For
166extremely optimized builds, we suggest building with
167the following options::
169 -Ddebug=true -Doptimization=3 -Dextra_optimizations=true -Dnative_build=true
171We suggest always keeping ``-Ddebug=true`` to assist
172with meaningful stack traces and bug reports.
177Compile after configuring the build directory::
179 meson compile -C build
181To clean the build directory while keeping the
182current configuration, use::
184 meson compile --clean -C build
189Once the program is built, it will need to be
190installed the first time before it can run (to
191install the `GSettings <https://developer.gnome.org/gio/stable/GSettings.html>`_ among other things)::
193 meson install -C build
195If you don't want to install anything permanent on
196your system, you can install it somewhere
197temporary by configuring with
198``--prefix=/tmp/zrythm`` for example, and
199then you can run it with
200``/tmp/zrythm/bin/zrythm_launch``.
205When running Zrythm from the command line, it is
206recommended to use ``zrythm_launch`` instead of
207running the ``zrythm`` binary directly. This takes
208care of using the correct GSettings schemas and
209other resources in the installed prefix.
211For debugging and other developer tools, see
212`HACKING.md <HACKING.md>`_.