Minor improvements to flatpak README

This commit is contained in:
miruka 2020-08-28 10:22:43 -04:00
parent 13dde2fe95
commit cb16ed0843

View File

@ -5,42 +5,34 @@
To build the Flatpak package, you will need `flatpak`, `flatpak-builder`, and To build the Flatpak package, you will need `flatpak`, `flatpak-builder`, and
KDE 5.14 runtime with SDK. `flatpak-builder` is usually available from KDE 5.14 runtime with SDK. `flatpak-builder` is usually available from
the same repository as `flatpak`. the same repository as `flatpak`.
See the [Flatpak setup instructions](https://flatpak.org/setup/)
[Flatpak setup instructions](https://flatpak.org/setup/) for your system.
To install the runtimes (remove the `--user` flag and run as root if you To install the runtimes (remove the `--user` flag and run as root if you
prefer system-wide installation): prefer system-wide installation):
``` ```sh
flatpak install --user flathub org.kde.Platform//5.14 org.kde.Sdk//5.14 flatpak install --user flathub org.kde.Platform//5.14 org.kde.Sdk//5.14
``` ```
If the download fails for some reason, run `flatpak repair` before retrying. If the download fails for some reason, run `flatpak repair` before retrying.
To build, run from the root of the project: To build, create a bundle and install it, run from the root of the project:
``` ```sh
make clean make clean
flatpak-builder --repo=build/flatpak/repo --force-clean build/flatpak/build packaging/flatpak/mirage.flatpak.yaml flatpak-builder --repo=build/flatpak/repo --force-clean build/flatpak/build packaging/flatpak/mirage.flatpak.yaml
```
To create bundle, run
```
flatpak build-bundle build/flatpak/repo build/mirage.flatpak io.github.mirukana.mirage flatpak build-bundle build/flatpak/repo build/mirage.flatpak io.github.mirukana.mirage
```
Then you can install it with
```
flatpak install --user build/mirage.flatpak flatpak install --user build/mirage.flatpak
``` ```
To run, either use your desktop environment or command line: To run the installed bundle,
``` either use your desktop environment or command line:
```sh
flatpak run io.github.mirukana.mirage flatpak run io.github.mirukana.mirage
``` ```
## Manifest ## Manifest
The manifest can be created using the included scripts, as described The manifest can be created using the included scripts, as described