diff --git a/doc/INSTALL.asciidoc b/doc/INSTALL.asciidoc index 339430b7c..90d90fdd9 100644 --- a/doc/INSTALL.asciidoc +++ b/doc/INSTALL.asciidoc @@ -21,14 +21,14 @@ repository (rather than a release): ---- # apt-get install asciidoc -# python3 scripts/asciidoc2html.py +$ python3 scripts/asciidoc2html.py ---- Then run tox like this to set up a https://docs.python.org/3/library/venv.html[virtual environment]: ---- -# tox -e mkvenv +$ tox -e mkvenv ---- This installs all needed Python dependencies in a `.venv` subfolder. The @@ -42,6 +42,8 @@ your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`): ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" ---- +Please also read about <>. + On Archlinux ------------ @@ -113,12 +115,14 @@ Then run tox like this to set up a https://docs.python.org/3/library/venv.html[virtual environment]: ---- -# tox -e mkvenv +$ tox -e mkvenv ---- This installs all needed Python dependencies in a `.venv` subfolder. The system-wide Qt5/PyQt5 installations are used in the virtual environment. +Please also read about <>. + On OS X ------- @@ -152,3 +156,17 @@ standard location for your distro (`/usr/share/applications` and The normal `setup.py install` doesn't install these files, so you'll have to do it as part of the packaging process. + +[[updating]] +Updating qutebrowser with tox +----------------------------- + +When you updated your local copy of the code (e.g. by pulling the git repo, or +extracting a new version), the virtualenv should automatically use the updated +code. However, if dependencies got added, this won't be reflected in the +virtualenv. Thus it's recommended to run the following command to recreate the +virtualenv: + +---- +$ tox -r -e mkvenv +----