Update changelog and install docs for v1.0.0

This commit is contained in:
Florian Bruhin 2017-10-12 09:10:41 +02:00
parent 5dca8cc8e5
commit 5905b27299
2 changed files with 29 additions and 62 deletions

View File

@ -4,7 +4,8 @@ Change Log
// http://keepachangelog.com/ // http://keepachangelog.com/
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
This project adheres to http://semver.org/[Semantic Versioning]. This project adheres to http://semver.org/[Semantic Versioning], though minor
breaking changes (such as renamed commands) can happen in minor releases.
// tags: // tags:
// `Added` for new features. // `Added` for new features.
@ -14,25 +15,29 @@ This project adheres to http://semver.org/[Semantic Versioning].
// `Fixed` for any bug fixes. // `Fixed` for any bug fixes.
// `Security` to invite users to upgrade in case of vulnerabilities. // `Security` to invite users to upgrade in case of vulnerabilities.
v1.0.0 (unreleased) v1.0.0
------------------- ------
Major changes Major changes
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
- Dependency changes - Dependency changes:
* Support for legacy QtWebKit (before 5.212 which is distributed independently * Support for legacy QtWebKit (before 5.212 which is
from Qt) is dropped. https://github.com/annulen/webkit/wiki[distributed independently from Qt])
is dropped.
* Support for Python 3.4 is dropped. * Support for Python 3.4 is dropped.
* Support for Qt before 5.7.1 and PyQt before 5.7 is dropped. * Support for Qt before 5.7.1 and PyQt before 5.7 is dropped.
* New dependency on the QtSql module and Qt sqlite support. * New dependency on the QtSql module and Qt sqlite support.
* New dependency on the `attrs` Python module. * New dependency on the http://www.attrs.org/[attrs] project (packaged as
`python-attr` in some distributions).
* The depedency on PyOpenGL (when using QtWebEngine) got removed. Note * The depedency on PyOpenGL (when using QtWebEngine) got removed. Note
that PyQt5.QtOpenGL is still a dependency. that PyQt5.QtOpenGL is still a dependency.
* PyQt5.QtOpenGL is now always required, even with QtWebKit. * PyQt5.QtOpenGL is now always required, even with QtWebKit.
- The QtWebEngine backend is now used by default. - The QtWebEngine backend is now used by default. Note this means that
QtWebEngine now should be a required dependency, and QtWebKit (if new enough)
should be changed to an optional dependency.
- Completely rewritten configuration system which ignores the old config file. - Completely rewritten configuration system which ignores the old config file.
See link:qute://help/configuring.html[] tfor details. See link:qute://help/configuring.html[] for details.
- Various documentation files got moved to the doc/ subfolder; - Various documentation files got moved to the doc/ subfolder;
`qutebrowser.desktop` got moved to misc/. `qutebrowser.desktop` got moved to misc/.
- `:set` now doesn't support toggling/cycling values anymore, that functionality - `:set` now doesn't support toggling/cycling values anymore, that functionality

View File

@ -44,7 +44,7 @@ to install qutebrowser via the Debian package.
Install the dependencies via apt-get: Install the dependencies via apt-get:
---- ----
# apt install python-tox python3-{lxml,pyqt5,sip,jinja2,pygments,yaml} python3-pyqt5.qt{webengine,quick,opengl,sql} libqt5sql5-sqlite # apt install python-tox python3-{lxml,pyqt5,sip,jinja2,pygments,yaml,attr} python3-pyqt5.qt{webengine,quick,opengl,sql} libqt5sql5-sqlite
---- ----
Get the qutebrowser package from the Get the qutebrowser package from the
@ -89,7 +89,8 @@ qutebrowser is available in the official repositories for Fedora 22 and newer.
---- ----
It's also recommended to install `python3-qt5-webengine` and start with `--backend It's also recommended to install `python3-qt5-webengine` and start with `--backend
webengine` to use the new backend. webengine` to use the new backend. v1.0.0 (which is not in the Fedora repos
currently) uses QtWebEngine by default.
On Archlinux On Archlinux
------------ ------------
@ -100,10 +101,6 @@ qutebrowser is available in the official [community] repository.
# pacman -S qutebrowser # pacman -S qutebrowser
---- ----
Archlinux packages an updated `qt5-webkit` package by default. If you want to
use the QtWebEngine backend instead, install `qt5-webengine` and start with
`--backend webengine`.
There is also a -git version available in the AUR: There is also a -git version available in the AUR:
https://aur.archlinux.org/packages/qutebrowser-git/[qutebrowser-git]. https://aur.archlinux.org/packages/qutebrowser-git/[qutebrowser-git].
@ -128,45 +125,14 @@ If video or sound don't work with QtWebKit, try installing the gstreamer plugins
On Gentoo On Gentoo
--------- ---------
WARNING: The Gentoo packages (even the live version) are lagging behind a lot, which means those instructions probably won't work anymore. Until things are looking better, it's recommended to <<tox,install qutebrowser via tox>>. The Gentoo packages (even the live version) are lagging behind a lot and are
effectively unmaintained. If you want to create and maintain an official
qutebrowser overlay for Gentoo, please mailto:mail@qutebrowser.org[get in
touch.]
A version of qutebrowser is available in the main repository and can be installed with: It's recommended to <<tox,install qutebrowser via tox>> instead.
---- To get an up-to-date QtWebKit, you can use
# emerge -av qutebrowser
----
However it is suggested to install the Live version (-9999) to take advantage
of the newest features introduced.
First of all you need to edit your package.accept_keywords file to accept the live
version:
----
# nano /etc/portage/package.accept_keywords
----
And add the following line to it:
=www-client/qutebrowser-9999 **
Save the file and then install qutebrowser via
----
# emerge -av qutebrowser
----
Or rebuild your system if you already installed it.
To update to the last Live version, remember to do
----
# emerge -uDNav @live-rebuild @world
----
To include qutebrowser among the updates.
You'll also need to install `dev-qt/qtwebengine` or a newer QtWebKit using
https://gist.github.com/annulen/309569fb61e5d64a703c055c1e726f71[this ebuild]. https://gist.github.com/annulen/309569fb61e5d64a703c055c1e726f71[this ebuild].
If video or sound don't work with QtWebKit, try installing the gstreamer If video or sound don't work with QtWebKit, try installing the gstreamer
@ -182,7 +148,6 @@ need to turn off the `bindist` flag for `dev-qt/qtwebengine`.
See the https://wiki.gentoo.org/wiki/Qutebrowser#USE_flags[Gentoo Wiki] for See the https://wiki.gentoo.org/wiki/Qutebrowser#USE_flags[Gentoo Wiki] for
more information. more information.
On Void Linux On Void Linux
------------- -------------
@ -197,6 +162,8 @@ It's currently recommended to install `python3-PyQt5-webengine` and
`python3-PyQt5-opengl`, then start with `--backend webengine` to use the new `python3-PyQt5-opengl`, then start with `--backend webengine` to use the new
backend. backend.
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
On NixOS On NixOS
-------- --------
@ -210,6 +177,8 @@ $ nix-env -i qutebrowser
It's recommended to install `qt5.qtwebengine` and start with It's recommended to install `qt5.qtwebengine` and start with
`--backend webengine` to use the new backend. `--backend webengine` to use the new backend.
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
On openSUSE On openSUSE
----------- -----------
@ -313,20 +282,13 @@ $ brew install qt5
$ pip3 install qutebrowser $ pip3 install qutebrowser
---- ----
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
Homebrew's builds of Qt and PyQt don't come with QtWebKit (and `--with-qtwebkit` Homebrew's builds of Qt and PyQt don't come with QtWebKit (and `--with-qtwebkit`
uses an old version of QtWebKit which qutebrowser doesn't support anymore). If uses an old version of QtWebKit which qutebrowser doesn't support anymore). If
you want QtWebKit support, you'll need to build an up-to-date QtWebKit you want QtWebKit support, you'll need to build an up-to-date QtWebKit
https://github.com/annulen/webkit/wiki/Building-QtWebKit-on-OS-X[manually]. https://github.com/annulen/webkit/wiki/Building-QtWebKit-on-OS-X[manually].
QtWebKit support, it is necessary to build from source. The build takes several
hours on an average laptop.
----
$ brew install qt5 --with-qtwebkit
$ brew install -s pyqt5
$ pip3 install qutebrowser
----
Packagers Packagers
--------- ---------