Skip to content

Latest commit

 

History

History
236 lines (183 loc) · 7.76 KB

README.asciidoc

File metadata and controls

236 lines (183 loc) · 7.76 KB

qutebrowser

A keyboard-driven, vim-like browser based on PyQt5 and QtWebKit.

qutebrowser is a keyboard-focused browser with with a minimal GUI. It’s based on Python, PyQt5 and QtWebKit and free software, licensed under the GPL.

It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.

Documentation

In addition to the topics mentioned in that README, the following documents are available:

Getting help

You can get help in the IRC channel #qutebrowser on Freenode (webchat), or by writing a message to the mailinglist at qutebrowser@lists.qutebrowser.org.

Running qutebrowser

After installing the requirements, you have these options:

  • Run qutebrowser directly via ./qutebrowser.py in the toplevel directory.

  • Run python3 setup.py install to install qutebrowser, then call qutebrowser.

Note
 If you’re running qutebrowser from the git repository rather than a released version, you should run scripts/asciidoc2html.py to generate the documentation.

Contributions / Bugs

You want to contribute to qutebrowser? Awesome! Please read HACKING for details and useful hints.

If you found a bug or have a feature request, you can report it in several ways:

Requirements

The following software and libraries are required to run qutebrowser:

To generate the documentation for the :help command, when using the git repository (rather than a release), asciidoc is needed.

The following libraries are optional and provide colored logging in the console:

On Debian

# apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python3-pkg-resources
python3-pip python3-jinja2 python3-pygments
# pip3 install pypeg2 --allow-external pypeg2 --allow-unverified pypeg2

To generate the documentation for the :help command, when using the git repository (rather than a release):

# apt-get install asciidoc

On Archlinux

There’s an Archlinux package available in pkg/. You can install it (and the python-pypeg2 dependency) like this:

$ wget https://aur.archlinux.org/packages/py/python-pypeg2/python-pypeg2.tar.gz (1)
$ tar xzvf python-pypeg2.tar.gz
$ cd python-pypeg2
$ makepkg -si
$ cd ..

$ mkdir qutebrowser
$ cd qutebrowser
$ wget http://git.the-compiler.org/qutebrowser/plain/pkg/PKGBUILD.qutebrowser-git -O PKGBUILD
$ makepkg -si
$ cd ..
$ rm -rf python-pypeg2.tar.gz python-pypeg2 qutebrowser

  1. Instead of the first block of commands you could also use an AUR helper, e.g. yaourt -S python-pypeg2.

As soon as v0.1 is out, there will be a package in the AUR, so this will get easier.

On Gentoo

Running qutebrowser on Gentoo is unfortunately rather hard because Qt5 and PyQt5 are not packaged officially. @posativ has written a howto with steps to get it running.

On Windows

As soon as v0.1 is out, a standalone .exe (built with cx_Freeze) will be provided. In the meantime, you can simply ask in IRC if you need one.

Authors

Contributors, sorted by the number of commits in descending order:

  • Florian Bruhin

  • Claude

Thanks / Similiar projects

Many projects with a similiar goal as qutebrowser exist:

  • dwb (C, GTK+ with WebKit1, currently unmaintained - main inspiration for qutebrowser)

  • vimb (C, GTK+ with WebKit1, active)

  • vimprobable (C, GTK+ with WebKit1, active)

  • surf (C, GTK+ with WebKit1, active)

  • luakit (C/Lua, GTK+ with WebKit1, not very active)

  • jumanji (C, GTK+ with WebKit1, not very active)

  • uzbl (C, GTK+ with WebKit1/WebKit2, active)

  • conkeror (Javascript, Emacs-like, XULRunner/Gecko, active)

  • lispkit (quite new, lisp, GTK+ with WebKit, active)

  • Vimperator (Firefox addon)

  • Pentadactyl (Firefox addon)

  • VimFx (Firefox addon)

  • vimium (Chrome/Chromium addon)

Most of them were inspirations for qutebrowser in some way, thanks for that!

Thanks as well to the following projects and people for helping me with problems and helpful hints:

Also, thanks to:

  • Everyone who had the patience to test qutebrowser before v0.1.

  • Everyone triaging/fixing my bugs in the Qt bugtracker

  • Everyone answering my questions on Stack Overflow and in IRC.

  • All the projects which were a great help while developing qutebrowser.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.