summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2020-01-22 20:47:16 +0100
committerFlorian Bruhin <me@the-compiler.org>2020-01-22 20:47:16 +0100
commitc59a55a41798677682eddaf6bd88ccc3a04f0c6c (patch)
tree9b7adc67c465156785194d60e7a053b041ea881d
parent4e22174fde0a78acad2d7d0d076caeec4b9ece95 (diff)
parent6be2bd79872bfd0529f8fb524c96d6da282c8545 (diff)
downloadqutebrowser-c59a55a41798677682eddaf6bd88ccc3a04f0c6c.tar.gz
qutebrowser-c59a55a41798677682eddaf6bd88ccc3a04f0c6c.zip
Merge remote-tracking branch 'origin/pr/5205'
-rw-r--r--doc/install.asciidoc12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/install.asciidoc b/doc/install.asciidoc
index 0b93b6c32..bd3d7cdc3 100644
--- a/doc/install.asciidoc
+++ b/doc/install.asciidoc
@@ -380,7 +380,9 @@ Then run the install script:
$ python3 scripts/mkvenv.py
----
-This installs all needed Python dependencies in a `.venv` subfolder.
+This installs all needed Python dependencies in a `.venv` subfolder
+(which subdirectory the environment is created in is configurable via the
+`--venv-dir` flag).
This comes with an up-to-date Qt/PyQt including a pre-compiled QtWebEngine
binary, but has a few caveats:
@@ -393,12 +395,14 @@ binary, but has a few caveats:
- It comes with a QtWebEngine compiled without proprietary codec support (such
as h.264).
-See the next section for an alternative.
+You can specify a Qt/PyQt verion with the `--pyqt-version` flag, see
+`mkenv.py --help` for a list of available versions. See the next section for
+an alternative.
Installing dependencies (system-wide Qt)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Alternatively, you can use `mkvenv.py --pyqt-mode link` to symlink your local
+Alternatively, you can use `mkvenv.py --pyqt-type link` to symlink your local
PyQt/Qt install instead of installing PyQt in the virtualenv. However, unless
you have a new QtWebKit or QtWebEngine available, qutebrowser will not work. It
also typically means you'll be using an older release of QtWebEngine.
@@ -406,7 +410,7 @@ also typically means you'll be using an older release of QtWebEngine.
On Windows, run `set PYTHON=C:\path\to\python.exe` (CMD) or ``$Env:PYTHON =
"..."` (Powershell) first.
-There is a third mode, `mkvenv.py --pyqt-mode source` which uses a system-wide
+There is a third mode, `mkvenv.py --pyqt-type source` which uses a system-wide
Qt but builds PyQt from source. In most scenarios, this shouldn't be needed.
Creating a wrapper script