Files
helvum/README.md
Sebastian Grabowski b25f6f9abb Update the extension versions in flatpak build instructions to 21.08
The extensions need to match the SDK version, that was updated to
org.gnome.Sdk//41 in Commit e5e02b13. (Version 41 is based on
org.freedesktop.Sdk//21.08)
2021-11-24 17:03:23 +01:00

57 lines
1.5 KiB
Markdown

Helvum is a GTK-based patchbay for pipewire, inspired by the JACK tool [catia](https://kx.studio/Applications:Catia).
![Screenshot](docs/screenshot.png)
[![Packaging status](https://repology.org/badge/vertical-allrepos/helvum.svg)](https://repology.org/project/helvum/versions)
# Features planned
- Volume control
- "Debug mode" that lets you view advanced information for nodes and ports
More suggestions are welcome!
# Building
## Via flatpak (recommended)
The recommended way to build is using flatpak, which will take care of all dependencies and avoid any problems that may come from different system configurations.
First, install the required flatpak platform and SDK, if you dont have them already:
```shell
$ flatpak install org.gnome.{Platform,Sdk}//41 org.freedesktop.Sdk.Extension.rust-stable//21.08 org.freedesktop.Sdk.Extension.llvm12//21.08
```
To compile and install as a flatpak, run
```shell
$ flatpak-builder --install flatpak-build/ build-aux/org.freedesktop.ryuukyu.Helvum.json
```
You can then run the app via
```shell
$ flatpak run org.freedesktop.ryuukyu.Helvum
```
## Manually
For compilation, you will need:
- Meson
- An up-to-date rust toolchain
- `libclang-3.7` or higher
- `gtk-4.0` and `pipewire-0.3` development headers
To compile and install, run
```shell
$ meson setup build && cd build
$ meson compile
$ meson install
```
in the repository root.
This will install the compiled project files into `/usr/local`.
# License
Helvum is distributed under the terms of the GPL3 license.
See LICENSE for more information.