Update doc and README to mention flatpak

This commit is contained in:
Bruno Herbelin
2022-12-13 18:32:32 +01:00
parent c1fb07b4c7
commit 2860d8f1de
3 changed files with 13 additions and 17 deletions

View File

@@ -8,7 +8,7 @@ Its intuitive and hands-on user interface gives direct control on image opacity
shape for producing live graphics during concerts and VJ-ing sessions.
The output image is typically projected full-screen on an external
monitor or a projector, but can be streamed live (SRT) or recorded (no audio).
monitor or a projector, and can be streamed live (SRT, Shmdata) or recorded (without audio).
vimix is the successor for GLMixer - https://sourceforge.net/projects/glmixer/
@@ -23,11 +23,15 @@ Check the [Quick Installation Guide](https://github.com/brunoherbelin/vimix/wiki
### Linux
Download and install a released snap package from https://snapcraft.io/vimix
Download and install a released [flatpak package](https://flathub.org/apps/details/io.github.brunoherbelin.Vimix)
~$ flatpak install --user vimix
Download and install a released [snap package](https://snapcraft.io/vimix) (slower release frequency)
~$ snap install vimix
Install the stable debian package
Install the stable debian package (slower release frequency)
~$ sudo apt install vimix
@@ -107,16 +111,6 @@ Follow the instructions to [install Shmdata](https://gitlab.com/sat-mtl/tools/sh
Building a flatpak package is a good option for having the latest version from git while avoiding to install all dependencies in your machine. Instructions are found [here](https://github.com/brunoherbelin/vimix/tree/master/flatpak).
### Generate snap
To generate the snap (from vimix directory):
$ snapcraft
To install and test the locally created snap:
$ snap install --dangerous vimix_0.X.Y_amd64.snap
### Memcheck
To generate memory usage plots in [massif format](https://valgrind.org/docs/manual/ms-manual.html):

View File

@@ -18,7 +18,7 @@ Watch this selection of [videos by Jean Detheux](https://vimeo.com/showcase/7871
### Linux
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/vimix)
[![Get it from flathub](https://flathub.org/assets/badges/flathub-badge-en.svg)](https://flathub.org/apps/details/io.github.brunoherbelin.Vimix)
### Mac OSX

View File

@@ -10,12 +10,14 @@ e.g. for Ubuntu:
~$ sudo apt install flatpak
## Install vimix from Flathub
## Install vimix releases from Flathub
If you followed all instructions of the [flatpak setup](https://flatpak.org/setup/), vimix should be in the list of packages.
~$ flatpak install --user vimix
## Build the flatpack package of vimix
## Build local pre-release flatpack package of vimix
If you want to have the latest developper version of vimix (before releases), you can build a vimix flatpak yourself.
@@ -69,7 +71,7 @@ To run from command line:
# Developper information
The flatpak manifest for flathub is at https://github.com/brunoherbelin/flathub
The flatpak manifest for flathub is at https://github.com/flathub/io.github.brunoherbelin.Vimix
To build the vimix flatpak with code from local folder (debugging), change the following: