rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,714 Commits 1 Branch 0 Tags 112 MiB
Python 74%
JavaScript 15.6%
Gherkin 6.3%
HTML 2.1%
Shell 0.9%
Other 0.9%
c4d4f4c8a5
Go to file
Florian Bruhin c4d4f4c8a5 Fix module-rgx in .pylintrc
2014-06-19 09:05:03 +02:00
pkg Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
qutebrowser Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
scripts Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
.flake8 Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
.gitignore Add git-commit-id to .gitignore 2014-05-15 08:51:33 +02:00
.pylintrc Fix module-rgx in .pylintrc 2014-06-19 09:05:03 +02:00
AUTHORS Add AUTHORS 2014-04-22 07:18:19 +02:00
BUGS Add a check whether print works. 2014-06-16 10:21:03 +02:00
COPYING Add GNU GPL 2014-02-06 14:01:23 +01:00
HACKING Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
MANIFEST.in Explicitely exclude BUGS in MANIFEST.in 2014-05-22 17:57:49 +02:00
notes Update notes/BUGS/TODO 2014-06-06 10:46:18 +02:00
README Update README 2014-06-17 18:01:15 +02:00
setup.py Add vim modelines to all files. 2014-06-19 09:04:37 +02:00
THANKS Use asciidoc syntax for THANKS 2014-06-17 17:57:11 +02:00
TODO Improve crash dialog 2014-06-19 07:53:17 +02:00

README 

qutebrowser readme
==================

About qutebrowser
-----------------

qutebrowser is a browser based on PyQt5 which aims to be keyboard-focused with
an input similar to vim.

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


Requirements
------------

The following software and libraries are required to run qutebrowser:

* http://www.python.org/[Python] 3.3 or newer (3.4 recommended)
* http://qt-project.org/[Qt] 5.2 or newer (5.3 recommended)
* QtWebKit
* http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2 or newer (5.3
  recommended) for Python 3
* https://pypi.python.org/pypi/setuptools/[pkg_resources/setuptools]

The following libraries are optional and provide better debugging:

* https://pypi.python.org/pypi/colorlog/[colorlog]
* On Windows: https://pypi.python.org/pypi/colorama/[colorama]
* https://pypi.python.org/pypi/ipdb[IPython/ipdb]

.On Debian:

    apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python3-pkg-resources

.On Archlinux:

    pacman -S python-pyqt5 qt5-webkit python-setuptools

Note an Archlinux AUR package is available.

.On Windows:

Use the installer from http://www.python.org/downloads[python.org] to get
Python 3 and the installer from
http://www.riverbankcomputing.com/software/pyqt/download5[Riverbank computing]
to get Qt and PyQt5. Run `scripts/ez_setup.py` to get setuptools.

Note a standalone .EXE is available.