aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2024-01-22 18:27:41 +0300
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2024-01-22 18:27:41 +0300
commit22df158af031a5bb0a126ce148e44d7fa4b5ad63 (patch)
tree4894b1bfe422c8eabcb4a0e22a3c4063daeebc70 /README.md
parent189a34d24326d2838c3dcd9ec7e9915c480e8873 (diff)
downloadapplause2-22df158af031a5bb0a126ce148e44d7fa4b5ad63.tar.gz
README: documented some FreeBSD tweaks
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 30 insertions, 8 deletions
diff --git a/README.md b/README.md
index f1ac59b..1e2194b 100644
--- a/README.md
+++ b/README.md
@@ -37,20 +37,42 @@ TODO: How to use jack-plumbing?
./applause -o 2
-This may require root rights for accessing HID devices.
-You may also add the current user to the `input` group.
-On FreeBSD, you might need to add the current user to the `wheel` group and
-give read acceess to evdev nodes by creating `/etc/devd.rules`:
-
- [localrules=10]
- add path 'input/*' mode 0640
-
Example (one channel):
> Stream.SinOsc(440):play()
You can also run standalone scripts (batch mode), just like the standard Lua interpreter.
+## Operating System Tweaks
+
+### Linux (Ubuntu)
+
+In order to run Jack and Applause with real-time scheduling, it should be sufficient to
+add your user to the `audio` group.
+
+To give regular users access to HID devices, it should suffice to add the current user to
+the `input` group.
+
+### FreeBSD
+
+For realtime scheduling, you might have to check out the mac_priority kernel module
+and add your user to the `realtime` group.
+
+Furthermore, to allow unlimited memory locking on FreeBSD for ordinary users,
+you should add the following entry to `/etc/login.conf`:
+
+ audio:\
+ :memorylocked=unlimited:\
+ :tc=default:
+
+Change the login class of your user to `audio` by running `chpass`.
+
+You might need to add the current user to the `wheel` group and
+give read acceess to evdev device nodes by creating `/etc/devd.rules`:
+
+ [localrules=10]
+ add path 'input/*' mode 0640
+
# Applause Clients (Editor Integration)
echo -ne "25 \nStream.SinOsc(440):play()" | socat -,ignoreeof TCP:127.0.0.1:10000"