ardour/livetrax
13
0
Fork 0
Code

Avoid regex convention in script documentation

Browse Source
This commit is contained in:
Carlo Stemberger 2020-10-22 06:09:35 +02:00 committed by Robin Gareus
parent a103a89f4f
commit 67cce59f4e
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
share/scripts/README
View File

@ -8,19 +8,19 @@ https://github.com/Ardour/ardour/tree/master/share/scripts
Script Naming conventions: Script Naming conventions:
^_ _
A script filename with a leading underscore indicates an example script. A script filename with a leading underscore indicates an example script.
These scripts are only available from ardour's git repository and not These scripts are only available from ardour's git repository and not
installed nor included with binary bundles. installed nor included with binary bundles.
^__ __
Scripts with a filename starting with two underscores are excluded from Scripts with a filename starting with two underscores are excluded from
unit-tests. This is currently the case for convolver, fluidsynth and unit-tests. This is currently the case for convolver, fluidsynth and
plugin-modulation. plugin-modulation.
They depend on external files (soundfont, impulse-response) or a specific They depend on external files (soundfont, impulse-response) or a specific
session-setup (plugin-modulation needs an automatable plugin). session-setup (plugin-modulation needs an automatable plugin).
^s_ s_
A filename beginning with "s_" indicates a code snippet. A filename beginning with "s_" indicates a code snippet.
These scripts can only be used in the interactive interpreter These scripts can only be used in the interactive interpreter
(Window > Scripting). They may be useful by themselves or handy for copy/edit (Window > Scripting). They may be useful by themselves or handy for copy/edit
@ -28,5 +28,5 @@ Script Naming conventions:
The filename prefix is only for convenience, "type" = "Snippet" is used when The filename prefix is only for convenience, "type" = "Snippet" is used when
scripts are listed at runtime. scripts are listed at runtime.
^_-*.lua _-*.lua
git ignores those. Intended for local/custom dev scripts or work in progress. git ignores those. Intended for local/custom dev scripts or work in progress.