diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..23d24ac --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 gora + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0896c5 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# soundboard + +A minimal soundboard for Linux, using PipeWire and Qt6. + +## Building + +This project uses [CMake](https://cmake.org/) as it's build system. To build +the project run the following commands: + +```console +$ mkdir build +$ cd build +$ cmake .. +$ make +``` + +The final `soundboard` executable will be located in the build directory. + +### Build dependencies + +- [Qt6](https://www.qt.io/development/qt-framework), the UI framework library + +### Runtime dependencies + +- [MPV](https://mpv.io/), the media player