docs/INSTALL.md: Update Flatpak instructions

Moment should be on Flathub soon enough, so let's tell users to get
it from there.
This commit is contained in:
Newbyte 2022-01-24 15:24:29 +01:00
parent e2fa1e82f8
commit 84f3d5071e
No known key found for this signature in database
GPG Key ID: 5873C171C9429CFA

View File

@ -39,38 +39,54 @@ see [manual installation](#manual-installation).
Packages other than the Flatpak are not maintained by the Mirage Packages other than the Flatpak are not maintained by the Mirage
authors, and thus might be outdated. authors, and thus might be outdated.
#### Flatpak (Leftover instructions from Mirage; not supported for Moment) #### Flatpak
Mirage is also available as a Flatpak. Mirage is also available as a Flatpak.
1. Download the Mirage Flatpak from the 1. Download the Mirage Flatpak from
[release page](https://github.com/mirukana/mirage/releases). [Flathub](https://flathub.org/apps/details/xyz.mx_moment.moment). Alternatively,
you can issue the following commands in a terminal:
```sh
flatpak remote-add --if-not-exists \
flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub xyz.mx_moment.moment
flatpak run xyz.mx_moment.moment
```
2. If your operating system doesn't already have built-in support for Flatpaks, 2. If your operating system doesn't already have built-in support for Flatpaks,
follow [these instructions](https://flatpak.org/setup/) to install Flatpak follow [these instructions](https://flatpak.org/setup/) to install Flatpak
support on your system. support on your system.
3. To actually install and run Mirage, it should be enough to double-click the ##### Configuration migration
downloaded `.flatpak` file, which will open your software manager.
Alternatively, you can issue the following commands in a terminal:
```sh Note that automatic migration of data from Mirage is not supported when using
flatpak remote-add --user --if-not-exists \ Flatpak. If you would like to manually migrate your logins, encryption keys,
flathub https://flathub.org/repo/flathub.flatpakrepo configuration and themes from Mirage, you can do it like so:
flatpak install --user flathub org.kde.Platform//5.14 ###### Migration from Mirage's Flatpak
flatpak install --user /path/to/downloaded/mirage-*.flatpak
flatpak run io.github.mirukana.mirage Issue the following commands:
```
If downloading the dependencies fail due to e.g. a connection error, $ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
run `flatpak repair` before retrying. $ cd ~/.var/app
$ cp -r io.github.mirukana.mirage/config/mirage/* xyz.mx_moment.moment/config/moment
$ cp -r io.github.mirukana.mirage/data/mirage/* xyz.mx_moment.moment/data/moment
If your architecture is not listed on the release page, clone the repository ###### Migration from a distribution package
and see [packaging/flatpak/README.md](packaging/flatpak/README.md) to build the
package on your machine.
Issue the following commands:
$ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
$ cd ~/.var/app
If you are on Debian, replace mirage with mirage-matrix in the following
commands:
$ cp -r ~/.config/mirage/* xyz.mx_moment.moment/config/moment
$ cp -r ~/.local/share/mirage/* xyz.mx_moment.moment/data/moment
## Manual Installation ## Manual Installation