]> git.0d.be Git - jack_mixer.git/commitdiff
Update and improve README and convert to Markdown
authorChristopher Arndt <chris@chrisarndt.de>
Wed, 15 Jul 2020 16:18:18 +0000 (18:18 +0200)
committerDaniel Sheeler <dsheeler@pobox.com>
Thu, 16 Jul 2020 19:12:44 +0000 (14:12 -0500)
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index 1e26591..0000000
--- a/README
+++ /dev/null
@@ -1,51 +0,0 @@
-jack_mixer -- Jack Audio Mixer
-==============================
-
-jack_mixer is a GTK+ JACK audio mixer app with look similar to its hardware
-counterpart.  It has lot of useful features, apart from being able to mix
-multiple JACK audio streams.
-
-It is licensed under GPL version 2 (or later), check COPYING for more info.
-
-Please visit project homepage is at https://rdio.space/jackmixer/ for more
-info.
-
-
-Installation
-------------
-
-Read INSTALL for information on installation.
-
-
-Using MIDI CCs to control jack_mixer
-------------------------------------
-
-MIDI CCs can be used to control volume, balance/panorama, mute, and solo
-of channels.
-
-Default controllers for added channels are chosen using predefined algorithm,
-first free controller starting from 11, first for volume, next for
-balance/panorama.
-
-So, if you don't delete channels, you will get CC#11 used for first input
-channel volume, CC#12 for first channel balance/panorama, CC#13 for second
-channel volume, CC#14 for second channel balance/panorama, etc.
-
-It is also possible to select other CCs when creating the channel, or
-afterwards from the channel properties dialog (accessible by double clicking
-on the channel name).
-
-MIDI CC values (0-127) are mapped to dBFS using current slider scale for
-corresponding channel.
-
-
-Feedback
---------
-
-If you have trouble getting jack_mixer working, find a bug or you miss some
-feature, please contact the maintainer by email.
-
-jack_mixer was initially written and supported by Nedko Arnaudov, it is now
-maintained by Frederic Peters. You can reach Frederic at fpeters (a.t) 0d
-(dot) be, and Nedko at nedko (a.t) arnaudov (dot) name.  They can also be
-found in #lad on FreeNode (as fredp and nedko).
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..dab1021
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+jack_mixer -- Jack Audio Mixer
+==============================
+
+**jack_mixer** is a GTK+ JACK audio mixer app with a look & handling similar to
+hardware mixing desks. It has lot of useful features, apart from being able to
+mix multiple JACK audio streams.
+
+It is licensed under GPL version 2 (or later), check the file [COPYING] for
+more information.
+
+Please visit the project's homepage at https://rdio.space/jackmixer/ for more
+information.
+
+
+## Installation
+
+To build and install jack_mixer one would typically run:
+
+```console
+./autogen.sh --prefix=/usr
+make
+sudo make install
+```
+
+Please read the file [INSTALL] for more information.
+
+
+## Using MIDI CCs to control jack_mixer
+
+MIDI Control Change messages (CCs) can be used to control volume,
+balance/panorama, mute, and solo of input and output channels.
+
+The default controllers for added channels are chosen using a predefined
+algorithm: the first free controller starting from #11, first for volume, next
+for balance/panorama, then mute and finally solo.
+
+So, if you don't delete channels, CC#11 will control the first channel's
+volume, CC#12 the balance/panorama, CC#13 the mute and CC#14 the solo switch.
+CC#15 will control the second channel' volume, CC#16 it's balance/panorama, and
+so on.
+
+It is also possible to set other CCs when creating a channel, or afterwards
+from the channel properties dialog (accessible from the menu or by double
+clicking on the channel name).
+
+MIDI CC values (0-127) are mapped to dBFS using the current slider scale for
+the corresponding channel.
+
+
+## Feedback
+
+If you have trouble getting jack_mixer working, find a bug or you miss some
+feature, please [create an issue] on GitHub or contact the maintainer by email.
+
+jack_mixer was initially written and supported by Nedko Arnaudov, it is now
+maintained by Frédéric Peters. You can reach Frédéric at fpeters (a.t) 0d (dot)
+be, and Nedko at nedko (a.t) arnaudov (dot) name.
+
+
+[COPYING]: ./COPYING
+[INSTALL]: ./INSTALL
+[create an issue]: https://github.com/jack-mixer/jack_mixer/issues