Skip to content

Commit 09c882f

Browse files
committed
documentation update
1 parent 31428d5 commit 09c882f

File tree

1 file changed

+38
-34
lines changed

1 file changed

+38
-34
lines changed

doc/PACKAGING.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,55 +10,59 @@ Perl Distribution Compactor depends on [Module::ScanDeps](https://metacpan.org/p
1010

1111
## AppImage Support
1212

13-
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:
13+
* **PEB AppImage Maker**
1414

15-
* packing a Perl application together with a PEB executable, its Qt libraries and a relocatable Perl distribution:
15+
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-
```bash
18-
./appimage-maker.sh --include-resources
19-
```
17+
* packing a Perl application together with a PEB executable, its Qt libraries and a relocatable Perl distribution:
2018

21-
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.
19+
```bash
20+
./appimage-maker.sh --include-resources
21+
```
2222

23-
* packing only a PEB executable with its Qt libraries:
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.
2424

25-
```bash
26-
./appimage-maker.sh --no-resources
27-
```
25+
* packing only a PEB executable with its Qt libraries:
26+
27+
```bash
28+
./appimage-maker.sh --no-resources
29+
```
30+
31+
In this case a PEB executable from an AppImage will try to find its application files and folders in the directory of the AppImage.
2832

29-
In this case a PEB executable from an AppImage will try to find its application files and folders in the directory of the AppImage.
33+
In both modes of operation, the PEB AppImage uses the [linuxdeployqt](https://github.com/probonopd/linuxdeployqt/releases/) tool to detect all Qt dependencies of PEB and build the final image.
3034

31-
In both modes of operation, the PEB AppImage uses the [linuxdeployqt](https://github.com/probonopd/linuxdeployqt/releases/) tool to detect all Qt dependencies of PEB and build the final image.
35+
The PEB AppImage Maker script must be started from the ``{PEB_executable_directory}/sdk`` directory.
3236

33-
The PEB AppImage Maker script must be started from the ``{PEB_executable_directory}/sdk`` directory.
37+
* **PEB AppImage Builder Docker Container**
3438

35-
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).
36-
To build it, type the following command in the PEB project root directory (the directory of the README.md):
39+
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).
40+
To build it, type the following command in the PEB project root directory (the directory of the README.md):
3741

38-
```bash
39-
sudo docker build -t peb-appimage-builder .
40-
```
42+
```bash
43+
sudo docker build -t peb-appimage-builder .
44+
```
4145

42-
To start the PEB AppImage Builder Docker Container, type the following command in the PEB project root directory:
46+
To start the PEB AppImage Builder Docker Container, type the following command in the PEB project root directory:
4347

44-
```bash
45-
sudo docker container run --rm -it -v $(pwd):/opt --user $(id -u):$(id -g) peb-appimage-builder
46-
```
48+
```bash
49+
sudo docker container run --rm -it -v $(pwd):/opt --user $(id -u):$(id -g) peb-appimage-builder
50+
```
4751

48-
When PEB AppImage Builder Docker Container is running, type:
52+
When PEB AppImage Builder Docker Container is running, type:
4953

50-
```bash
51-
cd /opt/sdk
52-
```
54+
```bash
55+
cd /opt/sdk
56+
```
5357

54-
To start the PEB AppImage Maker, type either:
58+
To start the PEB AppImage Maker, type either:
5559

56-
```bash
57-
./appimage-maker.sh --no-resources
58-
```
60+
```bash
61+
./appimage-maker.sh --no-resources
62+
```
5963

60-
or
64+
or
6165

62-
```bash
63-
./appimage-maker.sh --include-resources
64-
```
66+
```bash
67+
./appimage-maker.sh --include-resources
68+
```

0 commit comments

Comments
 (0)