From 203116ee3d07b71d43f330970ad256572351c7cb Mon Sep 17 00:00:00 2001 From: miruka Date: Thu, 26 Mar 2020 12:05:13 -0400 Subject: [PATCH] README, mirage.pro: more style improvements --- mirage.pro | 3 ++- packaging/flatpak/README.md | 36 +++++++++++++++--------------------- 2 files changed, 17 insertions(+), 22 deletions(-) diff --git a/mirage.pro b/mirage.pro index 5b35e717..f0032d58 100644 --- a/mirage.pro +++ b/mirage.pro @@ -107,5 +107,6 @@ for(file, $$list($$glob_filenames(*.py))) { QMAKE_CLEAN *= $$MOC_DIR $$OBJECTS_DIR $$RCC_DIR $$PYCACHE_DIRS $$QRC_FILE QMAKE_CLEAN *= $$BUILD_DIR $$TARGET Makefile mirage.pro.user .qmake.stash QMAKE_CLEAN *= $$glob_filenames(*.pyc, *.qmlc, *.jsc, *.egg-info) -QMAKE_CLEAN *= packaging/flatpak/flatpak-env packaging/flatpak/requirements.txt packaging/flatpak/flatpak-requirements.txt +QMAKE_CLEAN *= packaging/flatpak/flatpak-env packaging/flatpak/requirements.txt +QMAKE_CLEAN *= packaging/flatpak/flatpak-requirements.txt QMAKE_CLEAN *= packaging/flatpak/flatpak-pip.json .flatpak-builder diff --git a/packaging/flatpak/README.md b/packaging/flatpak/README.md index 51957e53..fce5a2e7 100644 --- a/packaging/flatpak/README.md +++ b/packaging/flatpak/README.md @@ -21,12 +21,12 @@ flatpak-builder --repo=build/flatpak/repo --force-clean build/flatpak/build pack To create bundle, run ``` -flatpak build-bundle build/flatpak/repo 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 mirage.flatpak +flatpak install --user build/mirage.flatpak ``` To run, either use your desktop environment or command line: @@ -37,31 +37,25 @@ flatpak run io.github.mirukana.mirage ## Manifest -Manifest can be created using the included scripts, as described +The manifest can be created using the included scripts, as described below. Please note it is intended to be done by the maintainers only. In particular, there could be some unexpected issues exposed by updates in Python modules that have to be resolved. -Manifest has to be updated by maintainers when the dependencies of -Mirage change, some updates in used Python modules are desired. +The manifest has to be updated by maintainers when the dependencies of +Mirage change, or some updates in used Python modules are desired. -Flatpak packaging manifest is generated by running -[generate-flatpak-script.sh](generate-flatpak-script.sh). This script -requires `libolm` to be installed on the development PC as it will -create Python virtual environment and install all the requirements in -it. +The Flatpak packaging manifest is generated by running +[generate-flatpak-script.sh](generate-flatpak-script.sh), which +uses [mirage.flatpak.base.yaml](mirage.flatpak.base.yaml) and replaces the +marked placeholder with Python dependencies. -Note that the requirements are taken from -[requirements.flatpak.txt](requirements.flatpak.txt) and the ones -specified in the project' root -[requirements.txt](../../requirements.txt). +This script requires `libolm` to be installed on the development PC, as it +will create Python virtual environment and install all the requirements in it. + +Note that the Python dependencies are taken from +[requirements.flatpak.txt](requirements.flatpak.txt) and the +project root's [requirements.txt](../../requirements.txt). In addition, the list of ignored packages is in [generate-flatpak-script.sh](generate-flatpak-script.sh). - -Flatpak manifest is created automatically by -[generate-flatpak-script.sh](generate-flatpak-script.sh) using -[mirage.flatpak.base.yaml](mirage.flatpak.base.yaml) and replacing the -marked placeholder with Python module dependencies. - -