Skip to content

Commit 94ea951

Browse files
committed
documentation update
1 parent 62234da commit 94ea951

File tree

4 files changed

+22
-6
lines changed

4 files changed

+22
-6
lines changed

CREDITS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ https://metacpan.org/pod/File::Copy::Recursive
3535
Thanks to [probonopd](https://github.com/probonopd) for his
3636
knowledgeable instructions and patient cooperation
3737
in the preparation and testing of Perl Executing Browser AppImages.
38-
His tool [linuxdeployqt](https://github.com/probonopd) is used to generate all released AppImages.
38+
His tool [linuxdeployqt](https://github.com/probonopd/linuxdeployqt) is used to generate all released AppImages.
3939
The [AppImageHub page of Perl Executing Browser](https://appimage.github.io/perl-executing-browser/) wouldn't be created without his assistance.
4040

4141
## Qt
@@ -253,10 +253,10 @@ https://ryanstutorials.net/bash-scripting-tutorial/bash-functions.php
253253

254254
## AppImage
255255

256-
https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html
257-
https://specifications.freedesktop.org/desktop-entry-spec/1.1/apa.html
256+
https://standards.freedesktop.org/menu-spec/latest/apa.html
258257
https://github.com/probonopd/linuxdeployqt
259258
http://output.jsbin.com/qoqukof
259+
https://unix.stackexchange.com/questions/156892/how-to-validate-verify-desktop-files
260260

261261
## Docker Containers
262262

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
[![GitHub Version](https://img.shields.io/github/release/ddmitov/perl-executing-browser.svg)](https://github.com/ddmitov/perl-executing-browser/releases)
44
[![GitHub License](http://img.shields.io/badge/License-LGPL%20v3-blue.svg)](./LICENSE.md)
5-
[![Travis CI Build Status](https://travis-ci.org/ddmitov/perl-executing-browser.svg?branch=master)](https://travis-ci.org/ddmitov/perl-executing-browser)
6-
[![Coverity Scan Build Status](https://scan.coverity.com/projects/11334/badge.svg)](https://scan.coverity.com/projects/ddmitov-perl-executing-browser)
5+
[![Travis CI Build Status](https://travis-ci.org/ddmitov/perl-executing-browser.svg?branch=master)](https://travis-ci.org/ddmitov/perl-executing-browser)
76

87
Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www.perl.org/) desktop applications. By default it runs local Perl 5 scripts as child processes with no server and is implemented as a C++ executable based on the [Qt 5](https://www.qt.io/) libraries. Inspired by [Electron](http://electron.atom.io/) and [NW.js](http://nwjs.io/), PEB is another reuse of web technologies in desktop applications with Perl doing the heavy lifting instead of [Node.js](https://nodejs.org/en/).
98

doc/PACKAGING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,23 @@ Perl Distribution Compactor depends on [Module::ScanDeps](https://metacpan.org/p
3434

3535
The PEB AppImage Maker script must be started from the ``{PEB_executable_directory}/sdk`` directory.
3636

37+
* **PEB AppImage Configuration Files**
38+
39+
``{PEB_executable_directory}/resources/app/{application_name}.desktop``
40+
``{PEB_executable_directory}/resources/app/{application_name}.appdata.xml``
41+
42+
``{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.
47+
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.
51+
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+
3754
* **PEB AppImage Builder Docker Container**
3855

3956
An easy building environment for PEB AppImage executables is the provided [PEB AppImage Builder Docker Container](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/Dockerfile).

resources/app/peb-demo.appdata.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<name>PEB Demo</name>
77
<summary>Perl Executing Browser Demo Package</summary>
88
<description>
9-
<p>Perl Executing Browser (PEB) is an HTML5 user interface for Perl 5 desktop applications. By default it runs local Perl 5 scripts as child processes with no server and is implemented as a C++ executable based on the Qt 5 libraries. Inspired by Electron and NW.js, PEB is another reuse of web technologies in desktop applications with Perl doing the heavy lifting instead of Node.js.</p>
9+
<p>Perl Executing Browser is an HTML interface for Perl 5 desktop applications.</p>
1010
</description>
1111
<launchable type="desktop-id">peb.desktop</launchable>
1212
<url type="homepage">https://github.com/ddmitov/perl-executing-browser</url>

0 commit comments

Comments
 (0)