diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# KF5 PulseAudio Qt Bindings - libpulse bindings for Qt + +PulseaudioQt allows programs using the Qt library to control volume and react to changes on systems which use PulseAudio. + +If you are reading this on GitHub, you should know that this repository is a mirror of the official KDE repository found [here](https://cgit.kde.org/pulseaudio-qt.git/) + +## Building +This is a cmake project, so you should be able to simply run `cmake` (with the proper command-line flags for your system setup), then `make`, then `make install` if desired. + +## Contributing +Contributions to this project are welcome! + +Bugs are tracked on the [KDE bug tracker](https://bugs.kde.org/enter_bug.cgi?product=pulseaudio-qt) + +Patches can be submitted on Phabricator using the `arc` command-line tool. Documentation and setup instrctions can be found [here](https://community.kde.org/Infrastructure/Phabricator#Using_Arcanist_to_post_patches)