Initial revision

README.md

@@ -0,0 +1,75 @@
+# ALSA Scarlett Gen 2/3 Control Panel (`alsa-scarlett-gui`)
+
+`alsa-scarlett-gui` is a Gtk4 GUI for the ALSA controls presented by
+the Linux kernel Focusrite Scarlett Gen 2/3 Mixer Driver.
+
+## About
+
+<img src="src/img/alsa-scarlett-gui-logo.png" align="right">
+
+The Focusrite Scarlett interfaces are class compliant USB audio
+interfaces meaning that they work “out of the box” on Linux as audio
+and MIDI interfaces (although on Gen 3 you need to disable MSD mode
+first). However, the Gen 2 6i6+ and Gen 3 4i4+ interfaces have a bunch
+of proprietary functionality that required a kernel driver to be
+written specifically for those devices.
+
+Linux kernel support (“ALSA Focusrite Scarlett Gen 2/3 Mixer Driver”)
+for the proprietary functionality of Gen 2 devices was first added in
+5.4 and Gen 3 devices in 5.14.
+
+Unfortunately, actually using this functionality was quite awful. The
+existing applications like `alsamixer` and `qasmixer` become
+completely user-hostile with the hundreds of controls presented for
+the Gen 3 18i20. Even the smallest Gen 3 4i4 interface at last count
+had 84 ALSA controls.
+
+Announcing the ALSA Scarlett Gen 2/3 Control Panel!
+
+The GUI supports all features presented by the driver (if not, please
+report a bug).
+
+## Documentation
+
+Refer to [USAGE.md](USAGE.md) for prerequisites, instructions, usage
+information, and known issues.
+
+## Donations
+
+This program is Free Software, developed using my personal resources,
+over hundreds of hours. Focusrite did not support the development of
+the driver or this control panel in any way. Thanks to Laurent
+Debricon who got me started on the Gen 3 drivers by donating a 4i4.
+
+If you like it, please consider a donation to say thank you as it was
+expensive to purchase one of each model for development and testing!
+Any donation is appreciated.
+
+- https://liberapay.com/gdb
+- https://paypal.me/gdbau
+
+Thank you!
+
+## License
+
+Copyright 2022 Geoffrey D. Bennett
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at
+your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+## Disclaimer Third Parties
+
+Focusrite and Scarlett are trademarks or registered trademarks of
+Focusrite Audio Engineering Limited in England, USA, and/or other
+countries. Use of these trademarks does not imply any affiliation or
+endorsement of this software.