From 1ad9a2b4aba6fa888f3112d8d4d81d37028f0762 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Sun, 27 Sep 2020 13:46:36 +0200 Subject: [PATCH] Add footnote on why ~/.local/share over /usr/local --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 44353a92..a3c0bb52 100644 --- a/README.md +++ b/README.md @@ -83,11 +83,11 @@ comprehensive documentation can be found in yabridgectl's readme, or by running First of all, yabridgectl needs to know where it can find yabridge's files. If you have downloaded the prebuilt binaries, then you can simply extract the archive to `~/.local/share` and yabridgectl will pick up the files in -`~/.local/share/yabridge` automatically. You also won't have to do any -additional setup if you're using one of the AUR packages. If you have compiled -yabridge from source or if you installed the files to some other location, then -you can use `yabridgectl set --path=` to tell yabridgectl where it can -find the files. +`~/.local/share/yabridge` automatically[\*](#why-local-share-yabridge). You also +won't have to do any additional setup if you're using one of the AUR packages. +If you have compiled yabridge from source or if you installed the files to some +other location, then you can use `yabridgectl set --path=` to tell +yabridgectl where it can find the files. Secondly, yabridgectl will default to the copy-based installation method. If you are using a VST host with individually sandboxed plugins such as Bitwig Studio @@ -105,6 +105,16 @@ tell your VST host to search for plugins in the directories you just added and you'll be good to go. Don't forget to rerun `yabridgectl sync` whenever you update yabridge if you are using the copy-based installation method. + + *Instead of copying yabridge's files to ~/.local/share, it would + also be possible to install yabridge to /usr/local/bin and + /usr/local/lib. While this does avoid the need to modify your + PATH environment variable when using the copy-based installation + method, it could also cause other issues if you're not careful. This is why + it's recommended to install yabridge to your home directory if you're not + using one of the AUR packages. + + ### Manual setup To set up yabridge without using yabridgectl, first download and extract