Added documentation
This commit is contained in:
25
README.md
Normal file
25
README.md
Normal 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
|
||||
Reference in New Issue
Block a user