Skip to content

Commit 394327e

Browse files
committed
documentation update
1 parent 13e285a commit 394327e

File tree

4 files changed

+11
-8
lines changed

4 files changed

+11
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
1818
* [Compile-Time Requirements](./doc/REQUIREMENTS.md#compile-time-requirements)
1919
* [Runtime Requirements](./doc/REQUIREMENTS.md#runtime-requirements)
2020
* FILES AND FOLDERS
21-
* [Application Filename](./doc/FILES.md#application-filename)
21+
* [Application Executable](./doc/FILES.md#application-executable)
2222
* [Application Files and Folders](./doc/FILES.md#application-files-and-folders)
2323
* SETTINGS
2424
* [Global Settings API](./doc/SETTINGS.md#global-settings-api)

doc/FILES.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Perl Executing Browser - Files and Folders
22

3-
PEB is created to work from any directory without installation and all file paths used by PEB are relative to the directory of the PEB executable, labeled as ``{PEB_executable_directory}`` within this documentation.
4-
53
## Application Executable
64

75
The executable binary file of the browser, ``peb`` or ``peb.exe`` by default, can be renamed with no restrictions or additional adjustments. It can take the name of the PEB-based application it is going to run.
86

97
## Application Files and Folders
108

11-
The following PEB files and folders are hard-coded in C++ code for faster application startup. The PEB application directory is compatible with the application directory of the [Electron](http://electron.atom.io/) framework.
9+
PEB is created to work from any directory without installation and all file paths used by PEB are relative to the directory of the PEB executable, labeled as ``{PEB_executable_directory}`` within this documentation.
10+
11+
The following PEB files and folders are hard-coded in C++ code for faster application startup.
12+
The PEB application directory is compatible with the application directory of the [Electron](http://electron.atom.io/) framework.
1213

1314
A minimal ``{PEB_executable_directory}`` looks like this:
1415

doc/INTERACTIVE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ PEB interactive Perl scripts are able to receive user input multiple times after
3232

3333
## Examples of Interactive Perl Scripts
3434

35-
The [index.htm](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/index.html) file of the demo package demonstrates how to start automatically one Perl interactive script in two instances.
35+
The [index.htm](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/index.html) file demonstrates how to start automatically one Perl interactive script in two instances.
3636

37-
The [interactive.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive.pl) script of the demo package is an example of a Perl interactive script using STDIN input.
37+
The [interactive.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive.pl) is a Perl interactive script using STDIN input.
3838

39-
The [interactive-tempfile.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive-tempfile.pl) script of the demo package is an example of a Perl interactive script using a temporary file. This script creates a temporary file on startup and sends to PEB its full path in the following JSON format:
39+
The [interactive-tempfile.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive-tempfile.pl) is a Perl interactive script using a temporary file.
40+
This script creates a temporary file on startup and sends to PEB its full path in the following JSON format:
4041

41-
```json
42+
```javascript
4243
{"tempfile":"/path/to/tempfile"}
4344
```
4445

resources/app/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
// PEB page settings:
2727
var pebSettings = {}; // 'pebSettings' object name is hard-coded.
2828
pebSettings.perlInterpreter = 'perl/bin/perl';
29+
// pebSettings.perlInterpreter = 'perl/perl/bin/wperl.exe';
2930
pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
3031
pebSettings.cutLabel = '- Cut -';
3132
pebSettings.copyLabel = '- Copy -';

0 commit comments

Comments
 (0)