Skip to content

Commit 9fb2f07

Browse files
committed
documentation update
1 parent bf1de15 commit 9fb2f07

File tree

5 files changed

+43
-15
lines changed

5 files changed

+43
-15
lines changed

CREDITS.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,17 @@ for being welcoming host of the first public presentation of Perl Executing Brow
2626
on the 2nd of March 2014 and for their helpful proposals.
2727
http://hackafe.org/
2828

29+
Thanks to Roderich Schupp and all contributors of the [Module::ScanDeps](https://metacpan.org/pod/Module::ScanDeps) CPAN module.
30+
31+
Thanks to Daniel Muey and all contributors of the [File::Copy::Recursive](https://metacpan.org/pod/File::Copy::Recursive) CPAN module.
32+
2933
## Qt
3034
https://github.com/richmoore/qt-examples/tree/master/sitespecificbrowser
3135
https://github.com/rsdn/avalon/blob/master/web_view.cpp
3236
https://github.com/ariya/phantomjs/blob/master/src/qt/src/3rdparty/webkit/Source/WebKit/qt/Api/qwebpage.cpp
3337
https://github.com/OtterBrowser/otter-browser/blob/master/src/modules/backends/web/qtwebengine/QtWebEnginePage.cpp
3438
https://github.com/OtterBrowser/otter-browser/blob/master/src/modules/backends/web/qtwebengine/QtWebEnginePage.h
39+
https://github.com/NixOS/nixpkgs/issues/16327
3540

3641
http://qt-project.org/doc/qt-4.8/qwebhistory.html
3742
http://qt-project.org/doc/qt-4.8/qdir.html
@@ -120,7 +125,6 @@ http://developer.nokia.com/community/wiki/How_to_write_data_to_a_file_in_Qt (def
120125
http://harmattan-dev.nokia.com/docs/library/html/qt4/qkeysequence.html (defunct)
121126
http://harmattan-dev.nokia.com/docs/library/html/qt4/qdir.html (defunct)
122127
http://harmattan-dev.nokia.com/docs/library/html/qt4/qtglobal.html (defunct)
123-
http://harmattan-dev.nokia.com/docs/library/html/qtwebkit/qwebpage.html (defunct)
124128

125129
http://stackoverflow.com/questions/10666998/qwebkit-display-local-webpage
126130
http://stackoverflow.com/questions/7402576/how-to-get-current-working-directory-in-a-qt-application
@@ -211,9 +215,6 @@ http://stackoverflow.com/questions/9051200/twitter-bootstrap-dropdown-menu
211215
http://stackoverflow.com/questions/2214066/get-list-of-all-input-objects-using-javascript-without-accessing-a-form-obj
212216
http://stackoverflow.com/questions/8963693/how-to-create-json-string-in-javascript
213217
http://stackoverflow.com/questions/8003089/dynamically-create-and-submit-form
214-
http://stackoverflow.com/questions/8003089/dynamically-create-and-submit-form
215-
http://stackoverflow.com/questions/588040/window-onload-vs-document-onload
216-
http://stackoverflow.com/questions/359788/how-to-execute-a-javascript-function-when-i-have-its-name-as-a-string
217218
https://stackoverflow.com/questions/6964927/how-to-create-a-form-dynamically-via-javascript
218219
https://stackoverflow.com/questions/16452699/how-to-reset-a-form-using-jquery-with-reset-method
219220
https://stackoverflow.com/questions/3955229/remove-all-child-elements-of-a-dom-node-in-javascript
@@ -225,10 +226,7 @@ http://www.tutorialrepublic.com/twitter-bootstrap-tutorial/bootstrap-dropdowns.p
225226
http://www.tutorialspoint.com/bootstrap/bootstrap_dropdown_plugin.htm
226227
http://twitter-bootstrap.node1.zygote.cc/javascript.html
227228

228-
http://css3buttongenerator.com/
229-
http://callmenick.com/post/various-css-input-text-styles
230229
http://www.raymondcamden.com/2015/03/06/warning-a-user-before-they-leave-a-form/
231-
https://css-tricks.com/snippets/javascript/check-if-function-exists-before-calling/
232230
http://youmightnotneedjquery.com/
233231

234232
## Markdown
@@ -241,10 +239,6 @@ http://meta.stackexchange.com/questions/70356/key-stroke-combination-markdown
241239
## Bash
242240
http://tldp.org/LDP/abs/html/fto.html
243241
https://www.shellhacks.com/bash-test-if-file-exists/
244-
https://www.shellcheck.net/
245-
246-
## Linux
247-
http://askubuntu.com/questions/501812/how-do-i-provide-arguments-to-a-command-run-from-gksudo
248242

249243
## Mac
250244
http://www.zestymeta.com/2013/02/qt-osx-app-bundles-and-you.html

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Perl Executing Browser
99

1010
Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www.perl.org/) desktop applications. It runs local Perl 5 scripts as child processes with no server or execution timeout and is implemented as a C++ executable based on the [Qt 5](https://www.qt.io/) libraries.
1111

12-
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. In contrast to Electron and NW.js, PEB does not depend on Node.js, runs JavaScript in a sandbox and blocks cross-origin requests.
12+
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. In contrast to Electron and NW.js, PEB does not depend on [Node.js](https://nodejs.org/en/), always runs JavaScript in a sandbox and blocks cross-origin requests.
1313

1414
## Contents
1515
* [Quick Start](#quick-start)
@@ -45,7 +45,8 @@ These are the basic steps for building your first PEB-based application:
4545
* **2.** Write [a settings JavaScript object](#perl-scripts-api) for every Perl script you are going to run.
4646

4747
* **3.** Write your Perl scripts.
48-
Input from local HTML forms is read just like reading POST or GET requests in a Perl CGI script. Use the [get-post-test.pl](resources/app/perl/get-post-test.pl) file as an example.
48+
Input from local HTML forms is read just like reading POST or GET requests in a Perl CGI script.
49+
You may use the [get-post-test.pl](resources/app/perl/get-post-test.pl) file as an example.
4950

5051
* **4.** Connect your Perl scripts to your local HTML page using [one of the three possible methods](#perl-scripts-api).
5152

@@ -117,6 +118,7 @@ CONFIG += app_bundle
117118
## Runtime Requirements
118119
* Qt 5 libraries.
119120
Their full list for a QtWebKit Linux build of PEB can be found inside the [start-peb-webkit.sh](start-peb-webkit.sh) script.
121+
Their full list for a QtWebEngine Linux build of PEB can be found inside the [start-peb-webengine.sh](start-peb-webengine.sh) script.
120122

121123
* Perl 5 distribution - any Linux, Mac or Windows Perl distribution.
122124

REQUIREMENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ make
1717
```
1818

1919
## Runtime Requirements
20-
* Qt 5 libraries - their full Linux list can be found inside the ``start-peb.sh`` script,
20+
* Qt 5 libraries.
21+
Their full list for a QtWebKit Linux build of PEB can be found inside the [start-peb-webkit.sh](start-peb-webkit.sh) script.
22+
Their full list for a QtWebEngine Linux build of PEB can be found inside the [start-peb-webengine.sh](start-peb-webengine.sh) script.
23+
2124
* Perl 5 distribution - any Linux, Mac or Windows Perl distribution.
2225

2326
Tested successfully using the following Perl distributions:

resources/app/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ <h2>Perl Executing Browser</h2>
272272

273273
<div class="row">
274274
<div class="col-lg-12 introduction">
275-
Inspired by <a href="http://electron.atom.io/">Electron</a> and <a href="http://nwjs.io/">NW.js</a>, PEB is another reuse of web technologies in desktop applications with Perl doing the heavy lifting. In contrast to Electron and NW.js, PEB does not depend on Node.js, runs JavaScript in a sandbox and blocks cross-origin requests.
275+
Inspired by <a href="http://electron.atom.io/">Electron</a> and <a href="http://nwjs.io/">NW.js</a>, PEB is another reuse of web technologies in desktop applications with Perl doing the heavy lifting. In contrast to Electron and NW.js, PEB does not depend on <a href="https://nodejs.org/en/">Node.js</a>, always runs JavaScript in a sandbox and blocks cross-origin requests.
276276
</div>
277277
</div>
278278

start-peb-webengine.sh

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#! /bin/sh
2+
3+
# Sometimes the Qt libraries that PEB depends on are not available on PATH.
4+
# This script can start a QtWebEngine build of PEB with no Qt libraries on PATH,
5+
# if the following libraries are placed in a folder named 'qt'
6+
# inside the folder of PEB binary and this script:
7+
8+
# qt/libicudata.so.56.1
9+
# qt/libicui18n.so.56.1
10+
# qt/libicuuc.so.56.1
11+
# qt/libQt5Core.so.5.8.0
12+
# qt/libQt5Gui.so.5.8.0
13+
# qt/libQt5Network.so.5.8.0
14+
# qt/libQt5Positioning.so.5.8.0
15+
# qt/libQt5PrintSupport.so.5.8.0
16+
# qt/libQt5Qml.so.5.8.0
17+
# qt/libQt5QuickWidgets.so.5.8.0
18+
# qt/libQt5WebChannel.so.5.8.0
19+
# qt/libQt5WebEngineCore.so.5.8.0
20+
# qt/libQt5WebEngineWidgets.so.5.8.0
21+
# qt/libQt5Widgets.so.5.8.0
22+
# qt/libqxcb.so
23+
24+
# This file list was created using the 'ldd' utility and a Qt5.8 build of PEB.
25+
26+
export NO_AT_BRIDGE=1
27+
export LD_LIBRARY_PATH=$(pwd)/qt
28+
export QT_QPA_PLATFORM_PLUGIN_PATH=$(pwd)/qt
29+
./peb

0 commit comments

Comments
 (0)