1 files changed, 50 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..86dec60
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+This is the JackOnAllDevices project, JOAD for short.
+
+The purpose is to scan for all ALSA / asound audio devices, and hook them
+all up to JACK.  Then it starts up JACK, and hooks up any joysticks it
+finds as MIDI controllers.  So any ALSA application gets routed through
+JACK.
+
+This is very rough for now, only just started writing it.  jackoffall is
+particularly crude and violent, lots of killall.
+
+Since it isn't a package yet, some setup is needed.
+
+The packages you need installed are -
+    luajit
+    jackd2
+    jack-tools for jack-plumbing, but other patch persistance methods could be used.
+    a2jmidid
+    zita-ajbridge
+    aseqjoy
+
+    qjackctl can be used as a visual patchbay, though I prefer catia from the KXStudio repos.
+
+You need to have the snd-aloop kernel module loaded.  The jackscanall
+script should be run at boot time, put it into /etc/boot.d/.  jackonall
+should be called on user login.  Probably don't need to run jackoffall on
+user logout.
+
+Alas ~/.asoundrc doesn't understand ~ or $HOME, or even "try the current
+directory" it seems.  So you have to hard code the path.  Make sure your
+~/.asoundrc includes something like this (an example is included) -
+
+</var/lib/JOAD/asoundrc>
+
+jackscanall scans for your sound devices and creates
+/var/lib/JOAD/asoundrc.  Run jackscanall once as root to create that
+file, and each time you need to change your devices.
+
+jackonall starts up JACK and friends, and creates JACK devices for all
+the things jackscanall found.  It creates the cloop and ploop devices
+that catch everything ALSA does.  Then creates MIDI devices for all your
+joysticks.
+
+jackoffall closes down everything jackonall started up.
+
+NOTE - Seems both ALSA and JACK are per user.  So you need to run
+jackonall and jackoffall for each user.
+
+TODO - Leave it running, and hotplug ALSA / asound audio devices. 
+        a2jmidid takes care of hotplugging MIDI devices.
+        Though I think I still need to deal with hotplugged joysticks.