Skip to content

Commit c84de27

Browse files
authored
electron: Various tweaks
1 parent ce901ef commit c84de27

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/electron.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
Electron
22
========
33

4-
Due to the nature of Electron, building Electron applications as Flatpaks
5-
requires a few extra steps compared with other applications. Thankfully,
6-
several tools and resources are available which make this much easier.
4+
Due to the nature of `Electron <https://www.electronjs.org/>`_, building
5+
Electron applications as Flatpaks requires a few extra steps compared with other
6+
applications. Thankfully, several tools and resources are available which make
7+
this much easier.
78

89
This guide provides information on how building Electron applications differs
910
from other applications. It also includes information on the tooling for
@@ -263,21 +264,22 @@ often best to link to it from the main manifest, which is done by adding
263264
Launching the app
264265
-----------------
265266

266-
The Electron app is run through a simple script. This can be given any name
267-
but must be specified in the manifest's ``"command":`` property. See below
268-
a sample wrapper for launching app:
267+
The Electron app is run through a simple shell script that wraps
268+
`zypak <https://github.com/refi64/zypak>`_. This script can be given any name
269+
but must be specified in the manifest's ``command`` property. See below for a
270+
sample wrapper to launch the app:
269271

270272
.. code-block:: yaml
271273
272274
- type: script
273275
dest-filename: run.sh
274276
commands:
275-
- zypak-wrapper.sh /app/main/electron-sample-app "$@"
277+
- zypak-wrapper /app/main/electron-sample-app "$@"
276278
277279
Build commands
278280
--------------
279281

280-
Last but not least, since the simple build option is being used, a list of
282+
Last but not least, since the ``simple`` buildsystem is being used, a list of
281283
build commands must be provided. As can be seen, ``npm`` is run with the
282284
``npm_config_offline=true`` environment variable, installing dependencies from
283285
packages that have already been cached. These are copied to ``/app/main/``.

0 commit comments

Comments
 (0)