Added documentation

This commit is contained in:
2026-07-07 05:27:58 +02:00
parent 71ce142351
commit 1747b852d6
2 changed files with 46 additions and 0 deletions

21
LICENSE Normal file
View File

@@ -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.

25
README.md Normal file
View File

@@ -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