Skip to content

Commit fb922a3

Browse files
authored
Update README.md
1 parent 09f8b3e commit fb922a3

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For Arch Linux and derivatives. Install with your AUR manager, like: `yay -S vir
3838

3939
### Flatpak
4040

41-
Flatpak support is planned, but currently not working correctly. **If you can help with this, please see below! :)**
41+
FlatHub is planned.
4242

4343
### Third-party packages
4444

@@ -53,19 +53,22 @@ These packages are maintained and provided by community members.
5353

5454
### Native
5555

56-
#### Dependencies
56+
#### Dependencies for building the native package or AppImage
57+
5758
Arch Linux: `sudo pacman -S git ninja libpipewire base-devel extra-cmake-modules cmake kirigami ki18n kcoreaddons breeze kiconthemes qt6-base qt6-declarative qqc2-desktop-style`
5859

59-
In case I forgot something, cmake will tell you. Please open an issue, so I can document the packages here.
60+
For other distributions, just look up how the packages are called in your distro: https://pkgs.org
61+
62+
#### Native (for users)
6063

61-
#### For users
6264
1. Clone repository: `git clone https://github.com/Berny23/virtual-surround-manager.git`
6365
2. Change directory: `cd virtual-surround-manager`
6466
3. Prepare Build directory: `cmake -B build -G Ninja`
6567
4. Build the project: `cmake --build build --config Release`
6668
5. Install the project: `sudo cmake --install build --config Release`
6769

68-
#### For developers
70+
#### Native (for developers)
71+
6972
1. Clone repository: `git clone https://github.com/Berny23/virtual-surround-manager.git`
7073
2. Change directory: `cd virtual-surround-manager`
7174
3. Prepare Build directory and set local install path: `cmake -B build -G Ninja --install-prefix ~/.local`
@@ -74,18 +77,18 @@ In case I forgot something, cmake will tell you. Please open an issue, so I can
7477

7578
### Flatpak
7679

77-
The UI, filter chain node creation and audio source node detection work fine. However, setting the metadata for actual routing does absolutely nothing and the connection is not visible in coppwr. But this should actually work, because EasyEffects and other apps also support Flatpak.
78-
79-
**IF YOU ARE A DEVELOPER, PLEASE HELP ME WITH THE FLATPAK. THANKS!**
80-
8180
1. Clone repository: `git clone https://github.com/Berny23/virtual-surround-manager.git`
8281
2. Change directory: `cd virtual-surround-manager`
8382
3. Build the flatpak: `flatpak-builder --force-clean --user --install-deps-from=flathub --repo=repo --install flatpak_build ./dist/flatpak/de.berny23.virtual_surround_manager.Devel.json`
8483
4. Run the program: `flatpak run de.berny23.virtual_surround_manager`
8584

8685
### AppImage
8786

88-
I don't even know how this is supposed to work. There are mutliple different builder tools with no clear documentation on which to use. I tried some, but my build just crashes when launching it.
87+
1. Clone repository: `git clone https://github.com/Berny23/virtual-surround-manager.git`
88+
2. Change directory: `cd virtual-surround-manager`
89+
3. Build the AppImage: `./dist/appimage/build_virtual_surround_manager.sh`
90+
4. Make executable: `chmod +x ./build_appimage/virtual-surround-manager-unknown-x86_64.AppImage`
91+
5. Run the program: `./build_appimage/virtual-surround-manager-unknown-x86_64.AppImage`
8992

9093
## Acknowledgements
9194

0 commit comments

Comments
 (0)