@@ -10,6 +10,7 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
10
10
11
11
## Contents
12
12
13
+ * [ Quick Start] ( #quick-start )
13
14
* [ Design Objectives] ( #design-objectives )
14
15
* [ Features] ( #features )
15
16
* [ Security] ( #security )
@@ -42,6 +43,60 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
42
43
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL"
43
44
in the documentation of this project are to be interpreted as described in [ RFC 2119] ( https://www.ietf.org/rfc/rfc2119.txt ) .
44
45
46
+ ## Quick Start
47
+
48
+ * ** 1.** [ Download the PEB Demo Application] ( https://github.com/ddmitov/perl-executing-browser/releases/latest ) .
49
+ 64-bit Linux single-file [ AppImage] ( https://appimage.org/ ) executable and
50
+ 32-bit Windows self-extracting ZIP archive are available.
51
+ They include everything you need to start developing PEB-based applications.
52
+
53
+ * ** 2.** Unpack:
54
+
55
+ 64-bit Linux:
56
+ ``` bash
57
+ peb-demo-xx.AppImage --appimage-extract
58
+ ```
59
+
60
+ Windows:
61
+ Unzip using any Windows unzip utility.
62
+
63
+ * ** 3.** Optionally install any CPAN modules you may need:
64
+
65
+ 64-bit Linux - from the extracted `` peb-demo `` directory:
66
+ ``` bash
67
+ cd resources/app/perl/bin
68
+ ./perl ./cpanm YourModule
69
+ ```
70
+
71
+ Windows - from the extracted `` peb-demo `` directory:
72
+ ``` batchfile
73
+ cd resources\app\perl
74
+ .\portableshell.bat
75
+ cpanm YourModule
76
+ ```
77
+
78
+ * ** 4.** Write your Perl application reading user input on STDIN:
79
+
80
+ ``` perl
81
+ my $input = <STDIN >;
82
+ chomp $input ;
83
+ ```
84
+
85
+ * ** 5.** Write a `` {PEB_executable_directory}/resources/app/index.html `` with
86
+ a [ settings JavaScript object] ( ./doc/SETTINGS.md#perl-scripts-api ) for every Perl script you want to use.
87
+ Start local Perl scripts by [ clicking a link or submitting a form to a special URL] ( ./doc/SETTINGS.md#perl-scripts-api ) .
88
+ [ Select files or folders with their full paths by clicking a link to a special URL] ( ./doc/SETTINGS.md#selecting-files-and-folders ) .
89
+
90
+ * ** 6.** Optionally pack your application:
91
+
92
+ 64-bit Linux - from the extracted `` peb-demo `` directory:
93
+ ``` bash
94
+ ./appimager.sh
95
+ ```
96
+
97
+ Windows:
98
+ Zip your PEB-based application using any Windows zip utility.
99
+
45
100
## Design Objectives
46
101
47
102
* ** 1. Easy and beautiful graphical user interface for Perl 5 desktop applications**
0 commit comments