Skip to content

Commit 36a7f35

Browse files
committed
documentation update
1 parent 09ab71b commit 36a7f35

File tree

5 files changed

+21
-13
lines changed

5 files changed

+21
-13
lines changed

CREDITS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ https://ryanstutorials.net/bash-scripting-tutorial/bash-functions.php
247247
https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html
248248
https://specifications.freedesktop.org/desktop-entry-spec/1.1/apa.html
249249

250-
## Macintosh
250+
## Mac
251251

252252
http://leonid.shevtsov.me/en/how-to-create-icns-icons-for-os-x
253253
https://iconverticons.com/online/

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,15 @@ in the documentation of this project are to be interpreted as described in [RFC
4949

5050
* Common Steps:
5151
* **1.** [Download PEB](https://github.com/ddmitov/perl-executing-browser/releases/latest).
52-
* **2.** [Select your Perl distribution](./doc/REQUIREMENTS.md#runtime-requirements).
52+
53+
* **2.** [Select your Perl distribution](./doc/REQUIREMENTS.md#runtime-requirements).
54+
Place your Perl relocatable distribution in:
55+
``{PEB_executable_directory}/resources/app/perl``
56+
Your relocatable Perl interpreter must be:
57+
``{PEB_executable_directory}/resources/perl/bin/perl`` on a Linux or Mac macine or
58+
``{PEB_executable_directory}/resources/perl/bin/wperl.exe`` on a Windows macine.
59+
Your relocatable PERL5LIB folder must be:
60+
``{PEB_executable_directory}/resources/perl/lib``
5361

5462
* Serverless Application:
5563
* **3.** Write your Perl application reading user input on STDIN:
@@ -59,14 +67,14 @@ in the documentation of this project are to be interpreted as described in [RFC
5967
chomp $input;
6068
```
6169

62-
* **4.** Write an appropriate HTML interface with a [settings JavaScript object](./doc/SETTINGS.md#perl-scripts-api) for your Perl application.
63-
Triggering a Perl script from a local HTML page is configured using [one of the three possible methods](./doc/SETTINGS.md#perl-scripts-api).
70+
* **4.** Write ``{PEB_executable_directory}/resources/app/index.html`` with a [settings JavaScript object](./doc/SETTINGS.md#perl-scripts-api) for your Perl application.
71+
Triggering a Perl script from a local HTML page can be configured using [one of the three possible methods](./doc/SETTINGS.md#perl-scripts-api).
6472
[Selecting files or folders with their full paths](./doc/SETTINGS.md#selecting-files-and-folders) is also possible.
6573

6674
* Local Server Application:
6775
* **3.** Write your Perl server application.
6876
* **4.** Write [local-server.json](./doc/SETTINGS.md#starting-local-server) for your local Perl server.
69-
* **5.** Write an appropriate HTML interface and connect it to your server application by traditional web communication protocols.
77+
* **5.** Write a start page.
7078

7179
## Design Objectives
7280

@@ -80,7 +88,7 @@ in the documentation of this project are to be interpreted as described in [RFC
8088

8189
* PEB can be started from any folder without installation procedure.
8290
* [Perl script output is seamlessly inserted in any local page.](./doc/SETTINGS.md#perl-scripts-api)
83-
* [Perl scripts with STDIN event loops can be repeatedly fed with data (Linux and Macintosh builds only).](./doc/SETTINGS.md#interactive-perl-scripts)
91+
* [Perl scripts with STDIN event loops can be repeatedly fed with data (Linux and Mac builds only).](./doc/SETTINGS.md#interactive-perl-scripts)
8492
* [Perl local servers can be started.](./doc/SETTINGS.md#starting-local-server)
8593
* [Any version of Perl 5 can be used.](./doc/REQUIREMENTS.md#runtime-requirements)
8694
* [Single file or multiple files, new filename, existing or new directory can be selected by user.](./doc/SETTINGS.md#selecting-files-and-folders)

doc/CONSTANTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A typical ``{PEB_executable_directory}`` looks like this:
1616
   │ └── {application_data}
1717
├── perl
1818
│   ├── bin
19-
│   │   └── {perl_interpreter}
19+
│   │   └── perl || wperl.exe
2020
│   └── lib
2121
│   └── {perl_modules}
2222
└── app.png

doc/REQUIREMENTS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Compile-Time Requirements
44

5-
The only Linux and Macintosh compile-time requirement of PEB is a Qt development bundle version 5.2 or any later version.
5+
The only Linux and Mac compile-time requirement of PEB is a Qt development bundle version 5.2 or any later version.
66

77
Compiling Windows binaries of PEB is subject to the following restrictions:
88

@@ -53,7 +53,7 @@ All compile-time settings require editing the ``src/peb.pro`` project file accor
5353

5454
Setting ``ANNULEN_QTWEBKIT`` to ``1`` has no effect on Qt versions 5.5 or lower.
5555

56-
* Macintosh Bundle
56+
* Mac Bundle
5757
To make a bundle-less binary, which is the default setting:
5858

5959
```QMake
@@ -81,10 +81,10 @@ All compile-time settings require editing the ``src/peb.pro`` project file accor
8181
Tested successfully using the following Perl distributions:
8282

8383
Linux 64-bit [Perlbrew](https://perlbrew.pl/) Perl versions 5.18.4, 5.23.7
84-
Linux 64-bit [Relocatable Perl](https://github.com/skaji/relocatable-perl) version 5.24.1
84+
Linux 64-bit [Relocatable Perl](https://github.com/skaji/relocatable-perl) versions 5.24.1, 5.26.1
8585
Windows 32-bit [Strawberry Perl](http://strawberryperl.com/) PortableZIP versions 5.12.2.0, 5.16.1.1, 5.20.2.1
8686

87-
To use a Perlbrew Perl with PEB create a symlink to the wanted Perl interpreter named:
88-
``{PEB_executable_directory}/perl/bin/perl``
87+
To use a Perlbrew Perl with PEB create a symlink at:
88+
``{PEB_executable_directory}/resources/perl/bin/perl``
8989

9090
PEB can also use any Perl on PATH.

src/peb.pro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ greaterThan (QT_MAJOR_VERSION, 4) {
4848
DEFINES += "ANNULEN_QTWEBKIT=$$ANNULEN_QTWEBKIT"
4949

5050
##########################################################
51-
# MACINTOSH BUNDLE
51+
# MAC BUNDLE
5252

5353
# To make a bundle-less binary:
5454
# BUNDLE = 0

0 commit comments

Comments
 (0)