summaryrefslogtreecommitdiff
path: root/doc/install.asciidoc
diff options
context:
space:
mode:
authorFlorian Bruhin <git@the-compiler.org>2017-11-16 08:52:28 +0100
committerFlorian Bruhin <git@the-compiler.org>2017-11-16 08:52:28 +0100
commit47480d07f01d52b6bfdbe675c7b78ebab11f659d (patch)
treeb5054dca7524efce34cae9382b2b0b62d555e390 /doc/install.asciidoc
parent625a2c30605b5acf92db3048be6b8e142be0ea79 (diff)
downloadqutebrowser-47480d07f01d52b6bfdbe675c7b78ebab11f659d.tar.gz
qutebrowser-47480d07f01d52b6bfdbe675c7b78ebab11f659d.zip
Make the docs for a tox wrapper script clearer
[ci skip]
Diffstat (limited to 'doc/install.asciidoc')
-rw-r--r--doc/install.asciidoc25
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/install.asciidoc b/doc/install.asciidoc
index 5ffb44687..dba1410eb 100644
--- a/doc/install.asciidoc
+++ b/doc/install.asciidoc
@@ -356,6 +356,20 @@ also typically means you'll be using an older release of QtWebEngine.
On Windows, run `tox -e 'mkvenv-win' instead, however make sure that ONLY
Python3 is in your PATH before running tox.
+Creating a wrapper script
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Running `tox` does not install a system-wide `qutebrowser` script. You can
+launch qutebrowser by doing `.venv/bin/python3 -m qutebrowser`.
+
+You can create a simple wrapper script to start qutebrowser somewhere in your
+`$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`):
+
+----
+#!/bin/bash
+~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
+----
+
Building the docs
~~~~~~~~~~~~~~~~~
@@ -368,17 +382,6 @@ Then, run:
$ python3 scripts/asciidoc2html.py
----
-Creating a wrapper script
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can then create a simple wrapper script to start qutebrowser somewhere in
-your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`):
-
-----
-#!/bin/bash
-~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
-----
-
Updating
~~~~~~~~