Skip to content

Commit 8aca0f1

Browse files
committed
documentation update
1 parent 753c2e9 commit 8aca0f1

File tree

2 files changed

+30
-22
lines changed

2 files changed

+30
-22
lines changed

ACKNOWLEDGEMENTS

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

2-
THANKS, ACKNOWLEDGEMENTS AND REFERENCES FOR
3-
PERL EXECUTING BROWSER
2+
PERL EXECUTING BROWSER -
3+
THANKS, ACKNOWLEDGEMENTS AND REFERENCES
4+
================================
45

56
Amata mea Argeia - gratiam magnam tibi ago!
67
Patientia tua in studiis meis computatoriis auxilium meum maximum!
@@ -37,7 +38,7 @@ This is the syntax highlighter of the Perl Debugger GUI inside Perl Executing Br
3738
https://metacpan.org/release/Syntax-Highlight-Engine-Kate
3839

3940
QT
40-
==
41+
================================
4142
https://gitorious.org/qt-examples/qt-examples/source/sitespecificbrowser
4243

4344
https://github.com/richmoore/qt-examples/tree/master/sitespecificbrowser
@@ -204,18 +205,20 @@ http://www.freehackers.org/thomas/2009/03/10/fixing-qmake-missing-rule-for-ts-qm
204205
http://lemirep.wordpress.com/2013/06/01/deploying-qt-applications-on-linux-and-windows-3/
205206

206207
CGI
207-
===
208+
================================
208209
http://en.wikipedia.org/wiki/Common_Gateway_Interface
209210

210211
PERL
211-
====
212-
Larry Wall, Tom Christiansen, Jon Orwant "Programming Perl. Third Edition", O'Reilly, July 2000, ISBN 0-596-00027-8, 31.13. use lib
212+
================================
213+
Larry Wall, Tom Christiansen, Jon Orwant "Programming Perl. Third Edition", O'Reilly, July 2000, ISBN 0-596-00027-8,
214+
31.13. use lib
213215
http://docstore.mik.ua/orelly/perl2/prog/ch31_13.htm
214216

215217
Peter Wainwright "Pro Perl. A comprehensive guide for developers who want to master the Perl programming language", Apress, 2005, p. 104 - 107
216218
https://books.google.bg/books?id=1bbjLxkBLaMC&pg=PA105
217219

218-
Eric Cholet, Stas Bekman "Practical mod_perl", O'Reilly, May 2003, ISBN 0-596-00227-0, 3.9.2.1. Modifying @INC
220+
Eric Cholet, Stas Bekman "Practical mod_perl", O'Reilly, May 2003, ISBN 0-596-00227-0,
221+
3.9.2.1. Modifying @INC
219222
http://modperlbook.org/html/3-9-2-1-Modifying-INC.html
220223

221224
http://www.perlmonks.org/?node_id=737134 "How to redirect STDOUT to an array (not executing program)"
@@ -242,13 +245,13 @@ http://modperlbook.org/html/3-9-2-1-Modifying-INC.html
242245
http://www.tutorialspoint.com/perl/perl_syscall.htm
243246

244247
MAC
245-
===
248+
================================
246249
http://www.zestymeta.com/2013/02/qt-osx-app-bundles-and-you.html
247250
http://leonid.shevtsov.me/en/how-to-create-icns-icons-for-os-x
248251
http://iconverticons.com/online/
249252

250253
HTML, CSS & JAVASCRIPT
251-
=================
254+
================================
252255
http://stackoverflow.com/questions/9051200/twitter-bootstrap-dropdown-menu
253256
http://stackoverflow.com/questions/9436534/ajax-tutorial-for-post-and-get
254257
http://stackoverflow.com/questions/6395720/get-data-from-php-array-ajax-jquery
@@ -288,3 +291,7 @@ http://css3buttongenerator.com/
288291
http://callmenick.com/post/various-css-input-text-styles
289292
http://www.raymondcamden.com/2015/03/06/warning-a-user-before-they-leave-a-form/
290293
https://css-tricks.com/snippets/javascript/check-if-function-exists-before-calling/
294+
295+
MARKDOWN
296+
================================
297+
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Perl Executing Browser (PEB) is a C++ [Qt 5] (https://www.qt.io/) WebKit impleme
3737
* Optional warning for unsaved data in HTML forms before closing a window to prevent accidental data loss.
3838

3939
**Development goodies:**
40-
* PEB can interact with the built-in Perl 5 debugger. Any Perl script can be selected for debugging in an HTML user interface. The debugger output is displayed together with the syntax highlighted source code of the debugged script and it's modules. Interaction with the built-in Perl debugger is an idea proposed by Valcho Nedelchev.
41-
* ```QWebInspector``` window can be invoked using Ctrl+I keyboard shortcut.
40+
* PEB can interact with the Perl 5 debugger in graphical mode - see section 'HTML Interface for the Perl Debugger'
41+
* ```QWebInspector``` window can be invoked using ```Ctrl+I``` keyboard shortcut.
4242
* Extensive optional logging of all browser activities.
4343

4444
## Compile-time Requirements
@@ -62,7 +62,8 @@ Compiled and tested successfully using:
6262
## Runtime Requirements
6363

6464
* Qt 5 libraries,
65-
* Perl 5 distribution - any Linux, Mac or Windows Perl distribution.
65+
* Perl 5 distribution - any Linux, Mac or Windows Perl distribution.
66+
[Strawberry Perl] (http://strawberryperl.com/) PortableZIP edition is successfully used with all Windows builds of PEB.
6667

6768
## Settings
6869

@@ -232,9 +233,9 @@ JavaScript-based settings are created to facilitate the development of fully tra
232233

233234
* **About Qt dialog box:** ```http://perl-executing-browser-pseudodomain/?type=browser```
234235

235-
## HTML interface for Interaction with the Perl Debugger
236-
237-
![PEB Perl Debugger HTML Interface](https://github.com/ddmitov/perl-executing-browser/raw/master/screenshots/peb-perl-debugger.png "PEB Perl Debugger HTML Interface")
236+
## HTML Interface for the Perl Debugger
237+
Any Perl script can be selected for debugging in an embedded HTML user interface. The debugger output is displayed together with the syntax highlighted source code of the debugged script and it's modules. Syntax highlighting is achieved using ```Syntax::Highlight::Engine::Kate``` CPAN module by Hans Jeuken and Gábor Szabó. Interaction with the built-in Perl debugger is an idea proposed by Valcho Nedelchev and provoked by the scarcity of graphical frontends for the built-in Perl debugger.
238+
![PEB Perl Debugger HTML Interface](https://github.com/ddmitov/perl-executing-browser/raw/master/screenshots/peb-perl-debugger.png "PEB Perl Debugger HTML Interface")
238239

239240
## Special URLs for Interaction with the Perl Debugger
240241

@@ -260,13 +261,13 @@ JavaScript-based settings are created to facilitate the development of fully tra
260261
* **Font files:** ```.eot``` ```.ttf``` ```.woff``` ```.woff2```
261262

262263
## Keyboard Shortcuts
263-
* Ctrl+A - Select All
264-
* Ctrl+C - Copy
265-
* Ctrl+V - Paste
266-
* F11 - toggle Fullscreen
267-
* Alt+F4 - Close window
268-
* Ctrl+P - Print
269-
* Ctrl+I - debug current page using ```QWebInspector```
264+
* ```Ctrl+A``` - Select All
265+
* ```Ctrl+C``` - Copy
266+
* ```Ctrl+V``` - Paste
267+
* ```F11``` - toggle Fullscreen
268+
* ```Alt+F4``` - Close window
269+
* ```Ctrl+P``` - Print
270+
* ```Ctrl+I``` - debug current page using ```QWebInspector```
270271

271272
## Security
272273

0 commit comments

Comments
 (0)