diff --git a/doc/install.asciidoc b/doc/install.asciidoc index de6e9f2f2..15e3ac93e 100644 --- a/doc/install.asciidoc +++ b/doc/install.asciidoc @@ -221,6 +221,10 @@ https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[qutebrows mailinglist] to get notified on new releases). You can install a newer version without uninstalling the older one. +The binary release ships with a QtWebEngine built without proprietary codec +support. To get support for e.g. h264/h265 videos, you'll need to build +QtWebEngine from source yourself with support for that enabled. + https://chocolatey.org/packages/qutebrowser[Chocolatey package] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -261,6 +265,10 @@ Note that you'll need to upgrade to new versions manually (subscribe to the https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[qutebrowser-announce mailinglist] to get notified on new releases). +The binary release ships with a QtWebEngine built without proprietary codec +support. To get support for e.g. h264/h265 videos, you'll need to build +QtWebEngine from source yourself with support for that enabled. + This binary is also available through the https://caskroom.github.io/[Homebrew Cask] package manager: @@ -355,6 +363,18 @@ also typically means you'll be using an older release of QtWebEngine. On Windows, run `tox -e 'mkvenv-win' instead, however make sure that ONLY Python3 is in your PATH before running tox. +Building the docs +~~~~~~~~~~~~~~~~~ + +To build the documentation, install `asciidoc` (note that LaTeX which comes as +optional/recommended dependency with some distributions is not required). + +Then, run: + +---- +$ python3 scripts/asciidoc2html.py +---- + Creating a wrapper script ~~~~~~~~~~~~~~~~~~~~~~~~~