Move note about conifg redirect to CONTRIBUTING.

This was a note for developers, so it makes more sense to have in
CONTRIBUTING.
This also adds a section on using tox, which was mentioned only in
INSTALL and not CONTRIBUTING.
This commit is contained in:
Ryan Roden-Corrent 2016-04-02 11:56:26 -04:00
parent 973afbcec9
commit 2634b333f2
2 changed files with 29 additions and 8 deletions

View File

@ -63,6 +63,35 @@ handy. Of course, if using git is the issue which prevents you from
contributing, feel free to send normal patches instead, e.g. generated via
`diff -Nur`.
Running qutebrowser with tox
-------------------------------
Once you have cloned the repository, you can run tox inside the qutebrowser
repository to set up a
https://docs.python.org/3/library/venv.html[virtual environment]:
----
$ tox -e mkvenv
----
This installs all needed Python dependencies in a `.venv` subfolder. The
system-wide Qt5/PyQt5 installations are symlinked into the virtual environment.
You can then create a simple wrapper script to start qutebrowser:
----
#!/bin/bash
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
----
If you regularly use a non-development version of qutebrowser, you may want to
redirect your development version it to a local config using the `-c` flag:
----
#!/bin/bash
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@"
----
Getting patches
~~~~~~~~~~~~~~~

View File

@ -266,14 +266,6 @@ your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`):
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
----
If you are developing on qutebrowser, you may want to redirect it to a local
config:
----
#!/bin/bash
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@"
----
Updating
~~~~~~~~