60 lines
1.7 KiB
Plaintext
60 lines
1.7 KiB
Plaintext
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.
|
|
|
|
|
|
Getting help
|
|
------------
|
|
|
|
Documentation is slowly catching up as this is a rather young project.
|
|
|
|
You can however get help in the IRC channel
|
|
irc://irc.freenode.org/#qutebrowser[#qutebrowser] on Freenode, or by writing a
|
|
message to the
|
|
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
|
|
mailto:qutebrowser@lists.qutebrowser.org[].
|
|
|
|
|
|
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]
|
|
|
|
.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.
|