aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2024-01-12 19:46:57 +0300
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2024-01-12 19:49:25 +0300
commitc339ed4def5854b8daa0cbf2733c00d54b672078 (patch)
treeca48670611aa8a249a2b6dea9d5cd2b7ab2fecae /README.md
parentd845d87e2c7fa7afb2ac0ecb239ae1cc0b341937 (diff)
downloadapplause2-c339ed4def5854b8daa0cbf2733c00d54b672078.tar.gz
minor FreeBSD compatibility fixes and documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 039b770..f1ac59b 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,15 @@ You have to manually build and install LuaJIT v2.1:
make
sudo make install
-Furthermore, install the following dependencies:
+Furthermore, install the following dependencies (Ubuntu):
sudo apt-get install build-essential libreadline-dev libjack-jackd2-dev \
libsndfile1 libasound2 feedgnuplot
+On FreeBSD, you will need the following packages/ports:
+
+ pkg install gmake readline jackit evdev-proto libsndfile alsa-lib p5-feedgnuplot
+
To compile the project, type:
make
@@ -35,6 +39,11 @@ TODO: How to use jack-plumbing?
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):