Skip to content

Commit 0bd9bb2

Browse files
committed
documentation update
1 parent 94ea951 commit 0bd9bb2

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

doc/PACKAGING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Perl Distribution Compactor depends on [Module::ScanDeps](https://metacpan.org/p
1414

1515
PEB or any PEB-based application can be easily packed as a 64-bit single-file Linux [AppImage](https://appimage.org/) executable by the [PEB AppImage Maker](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/appimage-maker.sh) script, which has two modes of operation:
1616

17-
* packing a Perl application together with a PEB executable, its Qt libraries and a relocatable Perl distribution:
17+
* packing a Perl application together with a PEB executable, Qt libraries and a relocatable Perl distribution:
1818

1919
```bash
2020
./appimage-maker.sh --include-resources
2121
```
2222

23-
In this case the PEB AppImage invokes the [Perl Distribution Compactor](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/compactor.pl), which finds all dependencies of all Perl scripts in the ``{PEB_executable_directory}/resources/app`` directory and copies only the necessary Perl modules.
23+
In this case, the PEB AppImage Maker invokes the [Perl Distribution Compactor](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/compactor.pl), which finds all dependencies of all Perl scripts in the ``{PEB_executable_directory}/resources/app`` directory and copies only the necessary Perl modules.
2424

2525
* packing only a PEB executable with its Qt libraries:
2626

@@ -40,16 +40,17 @@ Perl Distribution Compactor depends on [Module::ScanDeps](https://metacpan.org/p
4040
``{PEB_executable_directory}/resources/app/{application_name}.appdata.xml``
4141

4242
``{PEB_executable_directory}/resources/app/{application_name}.desktop``
43-
is mandatory for any PEB-based application, that is going to be packed as an AppImage using the PEB AppImage Maker. A minimal example of ``{application_name}.desktop`` is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.desktop).
44-
``Icon=app`` inside ``{application_name}.desktop`` must not be changed for the proper display of the application icon.
45-
All registered categories in an ``{application_name}.desktop`` are available [here](https://standards.freedesktop.org/menu-spec/latest/apa.html).
46-
Any ``{application_name}.desktop`` file can be validated using the ``desktop-file-validate`` tool from the ``desktop-file-utils`` package in all major Linux distributions.
43+
is mandatory for any PEB-based application going to be packed by the PEB AppImage Maker.
44+
A minimal example of ``.desktop`` is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.desktop).
45+
``Icon=app`` inside ``.desktop`` must not be changed for the proper display of the application icon.
46+
All registered categories in an ``.desktop`` are available [here](https://standards.freedesktop.org/menu-spec/latest/apa.html).
47+
Any ``.desktop`` file can be validated using the ``desktop-file-validate`` tool from
48+
the ``desktop-file-utils`` package in all major Linux distributions.
4749

48-
The [AppStream Generator](http://output.jsbin.com/qoqukof) of [probonopd](https://github.com/probonopd) is the recommended tool for generating AppStream (.appdata.xml) files for PEB-based applications.
49-
An example of ``{aplication_name}.appdata.xml`` is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.appdata.xml).
50-
``{application_name}.appdata.xml`` is not mandatory, but is highly recommended.
50+
The [AppStream Generator](http://output.jsbin.com/qoqukof) of [probonopd](https://github.com/probonopd) is the recommended tool for generating AppStream ``.appdata.xml`` files for PEB-based applications. An example AppStream file is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.appdata.xml).
51+
An AppStream file is not mandatory, but is highly recommended.
5152

52-
Both PEB AppImage configuration files are copied on their proper places in the AppImage directory tree structure by the PEB AppImage Maker script.
53+
Both PEB AppImage configuration files are put on their places in the AppImage directory tree structure by the PEB AppImage Maker script.
5354

5455
* **PEB AppImage Builder Docker Container**
5556

0 commit comments

Comments
 (0)