From 2db07c740de134c3cf6d3dd31f8130f3745c92cc Mon Sep 17 00:00:00 2001 From: Salim B Date: Wed, 12 Mar 2025 18:20:51 +0100 Subject: [PATCH 1/4] electron: Various tweaks --- docs/electron.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/electron.rst b/docs/electron.rst index 2ba46086..171607a9 100644 --- a/docs/electron.rst +++ b/docs/electron.rst @@ -251,21 +251,22 @@ often best to link to it from the main manifest, which is done by adding Launching the app ----------------- -The Electron app is run through a simple script. This can be given any name -but must be specified in the manifest's ``"command":`` property. See below -a sample wrapper for launching app: +The Electron app is run through a simple shell script that wraps +`zypak `_. This script can be given any name +but must be specified in the manifest's :ref:`Command` property. See below for a +sample wrapper to launch the app: .. code-block:: yaml - type: script dest-filename: run.sh commands: - - zypak-wrapper.sh /app/main/electron-sample-app "$@" + - zypak-wrapper /app/main/electron-sample-app "$@" Build commands -------------- -Last but not least, since the simple build option is being used, a list of +Last but not least, since the ``simple`` build system is being used, a list of build commands must be provided. As can be seen, ``npm`` is run with the ``npm_config_offline=true`` environment variable, installing dependencies from packages that have already been cached. These are copied to ``/app/main/``. From 6d845163cdcae194a82ad7e7e38260cf520a46a9 Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 13 Mar 2025 00:38:09 +0100 Subject: [PATCH 2/4] electron: Link to project page --- docs/electron.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/electron.rst b/docs/electron.rst index 171607a9..2f237657 100644 --- a/docs/electron.rst +++ b/docs/electron.rst @@ -1,9 +1,10 @@ Electron ======== -Due to the nature of Electron, building Electron applications as Flatpaks -requires a few extra steps compared with other applications. Thankfully, -several tools and resources are available which make this much easier. +Due to the nature of `Electron `_, building +Electron applications as Flatpaks requires a few extra steps compared with other +applications. Thankfully, several tools and resources are available which make +this much easier. This guide provides information on how building Electron applications differs from other applications. It also includes information on the tooling for From 895787fa966b937991e75d6e9bb667737b2cc83c Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 13 Mar 2025 04:34:25 +0100 Subject: [PATCH 3/4] Update docs/electron.rst Co-authored-by: bbhtt --- docs/electron.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/electron.rst b/docs/electron.rst index 2f237657..d3e83e3c 100644 --- a/docs/electron.rst +++ b/docs/electron.rst @@ -267,7 +267,7 @@ sample wrapper to launch the app: Build commands -------------- -Last but not least, since the ``simple`` build system is being used, a list of +Last but not least, since the ``simple`` buildsystem is being used, a list of build commands must be provided. As can be seen, ``npm`` is run with the ``npm_config_offline=true`` environment variable, installing dependencies from packages that have already been cached. These are copied to ``/app/main/``. From d570e3912a8ad7a4b9ff2b3a5bfcb350c7c4dc37 Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 13 Mar 2025 04:56:47 +0100 Subject: [PATCH 4/4] Update docs/electron.rst Co-authored-by: bbhtt --- docs/electron.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/electron.rst b/docs/electron.rst index d3e83e3c..58055ba9 100644 --- a/docs/electron.rst +++ b/docs/electron.rst @@ -254,7 +254,7 @@ Launching the app The Electron app is run through a simple shell script that wraps `zypak `_. This script can be given any name -but must be specified in the manifest's :ref:`Command` property. See below for a +but must be specified in the manifest's ``command`` property. See below for a sample wrapper to launch the app: .. code-block:: yaml