Skip to content

Commit ad33f92

Browse files
committed
documentation update
1 parent d2a4a1b commit ad33f92

File tree

2 files changed

+29
-28
lines changed

2 files changed

+29
-28
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Inspired by [Electron](http://electron.atom.io/) and [NW.js](http://nwjs.io/), P
1919
* [Limitations](#limitations)
2020
* [REQUIREMENTS](./REQUIREMENTS.md)
2121
* [Compile-Time Requirements](./REQUIREMENTS.md#compile-time-requirements)
22+
* [Compile-Time Settings](./REQUIREMENTS.md#compile-time-settings)
2223
* [Runtime Requirements](./REQUIREMENTS.md#runtime-requirements)
2324
* [CONSTANTS](./CONSTANTS.md)
2425
* [Hard Coded Files and Folders](./CONSTANTS.md#hard-coded-files-and-folders)

REQUIREMENTS.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Perl Executing Browser - Requirements
55
The only Linux and Macintosh compile-time requirement of PEB is a GCC-based Qt development bundle version 5.2 or any later version.
66

77
The source code of PEB is not MSVC-compatible and PEB can not be compiled using any MSVC-based Windows version of Qt. This means that:
8-
1. PEB Windows binaries can be compiled only by a GCC-based Qt development bundle.
9-
2. Only ``QtWebKit`` can be used by a Windows binary of PEB.
10-
``QtWebEngine`` is included only in the MSVC-based Qt development bundles.
11-
3. Updated ``QtWebKit`` headers and libraries have to be manually added from the
12-
[QtWebKit repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases) for all Qt versions higher than 5.5.
8+
* PEB Windows binaries can be compiled only by a GCC-based Qt development bundle.
9+
* Only ```QtWebKit``` can be used by a Windows binary of PEB.
10+
Windows GCC-based Qt development bundles version 5.6 or later have neither ```QtWebEngine```, nor ```QtWebKit```.
11+
* Updated ``QtWebKit`` headers and libraries have to be manually added from the
12+
[QtWebKit repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases) to all Windows GCC-based Qt development bundles version 5.6 or later.
1313

1414
Compiled and tested successfully using:
1515
* [Qt Creator 3.0.0 and Qt 5.2.0](http://download.qt.io/archive/qt/5.2/5.2.0/) on 32-bit Debian and 32-bit Windows XP
@@ -29,38 +29,38 @@ make
2929
## Compile-Time Settings
3030
All compile-time settings require editing the ``src/peb.pro`` project file according to the following instructions.
3131

32-
* QtWebKit Use
33-
To use ```QtWebKit``` or ```QtWebEngine``` depending on the Qt version, which is the default setting:
32+
* QtWebKit Use
33+
To use ```QtWebKit``` or ```QtWebEngine``` depending on the Qt version, which is the default setting:
3434

35-
```QMake
36-
ANNULEN_QTWEBKIT = 0
37-
```
35+
```QMake
36+
ANNULEN_QTWEBKIT = 0
37+
```
3838

39-
The default web engine for Qt versions up to 5.5.x is ```QtWebKit```.
40-
The default web engine for Qt versions 5.6.x or higher is ```QtWebEngine```.
39+
The default web engine for Qt versions up to 5.5.x is ```QtWebKit```.
40+
The default web engine for Qt versions 5.6.x or higher is ```QtWebEngine```.
4141

42-
To use [an updated QtWebKit version from the repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases) with a Qt version higher than 5.5:
42+
To use [an updated QtWebKit version from the repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases) with a Qt version higher than 5.5:
4343

44-
```QMake
45-
# ANNULEN_QTWEBKIT = 1
46-
```
44+
```QMake
45+
ANNULEN_QTWEBKIT = 1
46+
```
4747

48-
Setting ```ANNULEN_QTWEBKIT``` to ```1``` has no effect on Qt versions 5.5 or lower.
48+
Setting ```ANNULEN_QTWEBKIT``` to ```1``` has no effect on Qt versions 5.5 or lower.
4949

50-
* Macintosh Bundle
51-
To make a bundle-less binary, which is the default setting:
50+
* Macintosh Bundle
51+
To make a bundle-less binary, which is the default setting:
5252

53-
```QMake
54-
BUNDLE = 0
55-
CONFIG -= app_bundle
56-
```
53+
```QMake
54+
BUNDLE = 0
55+
CONFIG -= app_bundle
56+
```
5757

58-
To make a bundled binary (peb.app):
58+
To make a bundled binary (peb.app):
5959

60-
```QMake
61-
BUNDLE = 1
62-
CONFIG += app_bundle
63-
```
60+
```QMake
61+
BUNDLE = 1
62+
CONFIG += app_bundle
63+
```
6464

6565
## Runtime Requirements
6666
* Qt 5 libraries.

0 commit comments

Comments
 (0)