Add the fix to the Changelog - Alex
[aseqjoy.git] / README
diff --git a/README b/README
index 9e6a981c4c2141550cc5be9f8ee491feb6b6b890..87f7b9f0d95db2dcacae4aa2a944a83ebe758d65 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,48 @@
-aseqjoy is a simple Joystick -> MIDI controller converter. 
+aseqjoy is a simple Joystick to ALSA MIDI Sequencer Converter
+-------------------------------------------------------------
+
+Copyright 2003 by Alexander K├Ânig - alex@lisas.de
+License: GPL V2 - see the file COPYING
 
 What it does: Each axis of the joystick device is mapped to a specific MIDI 
-Controller. Moving the joystick along an axis will cause aseqjoy to emit
+controller. Moving the joystick along an axis will cause aseqjoy to emit
 MIDI controller messages via ALSA's sequencer API. The value of the controller
 message represents the joystick's position along the axis (eg 'left' -> 0, 
 'middle' -> 63, 'right' -> 127).
 
 aseqjoy uses the ALSA sequencer API to emit the MIDI events. Therefor it
 creates and output port named after joystick used. You can then use for example
-the alsa-patch-bay to connect an aseqjoy instance to an input port of your
-choice. 
+aconnect (from alsa-utils) or Robert Ham's alsa-patch-bay to connect an aseqjoy
+instance to an input port of your choice. 
 
 Requirements:
+-------------
+
 - Linux System with correctly configured Joystick support.
 - A working ALSA 0.9 installation.
 
 Links:
-aseqjoy homepage: http://terminatorX.cx/aseqjoy
+------
+
+aseqjoy homepage: http://terminatorX.cx/aseqjoy.html
 ALSA homepage: http://www.alsa-project.org
-Input Utils: http://.cz
-ALSA-patch-bay: http://
+Joystick utils: http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/
+ALSA-patch-bay: http://pkl.net/~node/alsa-patch-bay.html
 
 Howto:
+------
+
+In some cases the joystick may not utilize the full range of available 
+controller values - in this case you should use "jscal" from the joystick
+package (most distributions feature this package) to calibrate your joystick 
+before running aseqjoy. Note: Analog PC joysticks are no high-precision 
+devices - so even after calibrating the device you might not always be able
+to reach "0" or "127" controller values - depending on the joystick you
+use.
 
-Start aseqjoy - if you have a working Joystick (Nr. 0) aseqjoy will detect
-that and each axis to a controller from 10 on upwards:
+Start aseqjoy - if you have a working Joystick (Nr. 0 - use the -d switch to
+select other joysticks) aseqjoy will detect that and map each axis of that 
+joystick to a controller from 10 on upwards:
 
 Axis -> Controller
    0 -> 10
@@ -34,7 +52,7 @@ Axis -> Controller
 From now on aseqjoy emits events over the "Joystick0" output port. To make use
 of these events in another application use for example the alsa-patch-bay
 to connect that output port to another application's input sequencer port
-(for example the "terminatorX" input port for terminatorX). After you bound
+(for example the "terminatorX" input port for terminatorX). After you've bound
 the controllers to certain controls you should see how moving the joystick
 affects the corresponding control.