a highly automated and intuitive digital audio workstation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Alexandros Theodotou 503ab89830
user manual: update projects, getting started, configuration, plugins
2 years ago
..
_static user manual: update projects, getting started, configuration, plugins 2 years ago
_templates use furo theme for html docs 2 years ago
appendix user manual: document ZRYTHM_DSP_THREADS in environment vars page 2 years ago
chords-and-scales read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
configuration user manual: update projects, getting started, configuration, plugins 2 years ago
contributing fix some broken links (CGit -> Gitea migration) 2 years ago
credits read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
editing user manual: add macro for using zrythm-dark icons 2 years ago
exporting user manual: add macro for using zrythm-dark icons 2 years ago
getting-started user manual: update projects, getting started, configuration, plugins 2 years ago
glossary read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
invoking-from-command-line user manual: implement custom lexer for tree command output, reformat configuration/getting started/projects/zrythm interface chapters 2 years ago
krita_work add manpage and user docs in this repository 4 years ago
locale user manual: update projects, getting started, configuration, plugins 2 years ago
mixing read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
modulators read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
playback-and-recording read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
plugins-files user manual: update projects, getting started, configuration, plugins 2 years ago
projects user manual: update projects, getting started, configuration, plugins 2 years ago
routing read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
scripting update po (add ukrainian translations) 2 years ago
theming read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
tracks user manual: add macro for using zrythm-dark icons 2 years ago
user-media read example scripts from .scm file (~alextee/zrythm-feature#253), add tests for them 2 years ago
zrythm-interface use furo theme for html docs 2 years ago
.gitignore fix arch build again 2 years ago
README.md user manual: add macro for using zrythm-dark icons 2 years ago
bundle_manual.sh user manual: fix html-zips containing absolute paths 2 years ago
conf.py.in user manual: update projects, getting started, configuration, plugins 2 years ago
index.rst user manual: minor fixes 2 years ago
meson.build use configuration for copyright years and name 2 years ago
post_process_po.py user manual: prettify API docs (use parens) 2 years ago
run_sphinx_build.sh user manual: remove duplicate transport controls description in Transport Bar section 2 years ago

README.md

Zrythm User Manual

Dependencies

Building

This is built using ninja -C build manual_bundle

Tips

  • To reference the Plugin Ports section in the file plugin-info.rst, use

    :ref:plugins-files/plugins/plugin-info:Plugin Ports

  • To reference editing/clip-editors/ruler.rst, depending on where the current document is use

    :doc:../editing/clip-editors/ruler

  • To reference a specific subsection anywhere, add .. _audio-bus-track: right before it, and reference it with

    :ref:audio-bus-track

  • To use zrythm-dark icons, use

    |icon_zoom-in|

Generally, prefer the 3rd option because files may move around, unless the reference needs to be more specific.

License

This manual is licensed under the GNU Free Documentation License, version 1.3 or later. See the index.rst file for details.

The full text of the license can be found in the root of this distribution.


Copyright (C) 2019-2021 Alexandros Theodotou

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.