summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2016-04-02 11:56:26 -0400
committerRyan Roden-Corrent <ryan@rcorre.net>2016-04-02 11:56:26 -0400
commit2634b333f2b7e1dccc4c8b0bbda14dd7805278bf (patch)
treef7e344b531b238b8862467aabea04a9e8e37c921
parent973afbcec98d92adcbac60b166a44547b5efa587 (diff)
downloadqutebrowser-2634b333f2b7e1dccc4c8b0bbda14dd7805278bf.tar.gz
qutebrowser-2634b333f2b7e1dccc4c8b0bbda14dd7805278bf.zip
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.
-rw-r--r--CONTRIBUTING.asciidoc29
-rw-r--r--INSTALL.asciidoc8
2 files changed, 29 insertions, 8 deletions
diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc
index 46a388143..f88f5cee5 100644
--- a/CONTRIBUTING.asciidoc
+++ b/CONTRIBUTING.asciidoc
@@ -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
~~~~~~~~~~~~~~~
diff --git a/INSTALL.asciidoc b/INSTALL.asciidoc
index 241f14f8d..1e1d0afd5 100644
--- a/INSTALL.asciidoc
+++ b/INSTALL.asciidoc
@@ -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
~~~~~~~~