From 47480d07f01d52b6bfdbe675c7b78ebab11f659d Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Thu, 16 Nov 2017 08:52:28 +0100 Subject: [PATCH] Make the docs for a tox wrapper script clearer [ci skip] --- doc/install.asciidoc | 25 ++++++++++++++----------- 1 file 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 ~~~~~~~~