Update docs
This commit is contained in:
parent
ce819db723
commit
a96120b65a
@ -27,6 +27,8 @@ Documentation
|
|||||||
In addition to the topics mentioned in this README, the following documents are
|
In addition to the topics mentioned in this README, the following documents are
|
||||||
available:
|
available:
|
||||||
|
|
||||||
|
* A http://qutebrowser.org/img/cheatsheet-big.png[keybinding cheatsheet]: +
|
||||||
|
image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser keybinding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
|
||||||
* link:doc/quickstart.asciidoc[Quick start guide]
|
* link:doc/quickstart.asciidoc[Quick start guide]
|
||||||
* link:doc/FAQ.asciidoc[Frequently asked questions]
|
* link:doc/FAQ.asciidoc[Frequently asked questions]
|
||||||
* link:doc/HACKING.asciidoc[HACKING]
|
* link:doc/HACKING.asciidoc[HACKING]
|
||||||
@ -68,7 +70,7 @@ Requirements
|
|||||||
The following software and libraries are required to run qutebrowser:
|
The following software and libraries are required to run qutebrowser:
|
||||||
|
|
||||||
* http://www.python.org/[Python] 3.4
|
* http://www.python.org/[Python] 3.4
|
||||||
* http://qt-project.org/[Qt] 5.2.0 or newer (5.3.2 recommended)
|
* http://qt-project.org/[Qt] 5.2.0 or newer (5.4 recommended)
|
||||||
* QtWebKit
|
* QtWebKit
|
||||||
* http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2.0 or newer
|
* http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2.0 or newer
|
||||||
(5.3.2 recommended) for Python 3
|
(5.3.2 recommended) for Python 3
|
||||||
@ -121,6 +123,11 @@ Contributors, sorted by the number of commits in descending order:
|
|||||||
* Martin Zimmermann
|
* Martin Zimmermann
|
||||||
// QUTE_AUTHORS_END
|
// QUTE_AUTHORS_END
|
||||||
|
|
||||||
|
The following people have contributed graphics:
|
||||||
|
|
||||||
|
* WOFall (icon)
|
||||||
|
* regines (keybinding cheatsheet)
|
||||||
|
|
||||||
Thanks / Similiar projects
|
Thanks / Similiar projects
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
|
@ -5,39 +5,14 @@ The Compiler <mail@qutebrowser.org>
|
|||||||
NOTE: This page will only appear on the first start. To view it at a later
|
NOTE: This page will only appear on the first start. To view it at a later
|
||||||
time, use the `:help` command.
|
time, use the `:help` command.
|
||||||
|
|
||||||
Known issues
|
|
||||||
------------
|
|
||||||
|
|
||||||
[WARNING]
|
|
||||||
====
|
|
||||||
`#include <std_disclaimer.h>`
|
|
||||||
|
|
||||||
qutebrowser still hasn't seen its v0.1 release, and there's a good reason for
|
|
||||||
it. There still are some issues (see below). I also might break it from time to
|
|
||||||
time, sometimes on purpose, sometimes not. It's a good idea to sign up on the
|
|
||||||
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] if
|
|
||||||
you use qutebrowser already.
|
|
||||||
====
|
|
||||||
|
|
||||||
* https://github.com/The-Compiler/qutebrowser/issues?q=is%3Aopen+is%3Aissue+downloads+in%3Atitle+label%3Abug[multiple
|
|
||||||
issues with downloads] (you probably shouldn't use them yet if you need to be
|
|
||||||
sure the resulting file isn't corrupted).
|
|
||||||
* There's a https://github.com/The-Compiler/qutebrowser/issues/132[race
|
|
||||||
condition in Qt] which leads to segfaults on some websites (e.g. Dropbox). This
|
|
||||||
will be fixed in Qt 5.4.0. Especially Debian users seem to be affected. It
|
|
||||||
seems as a workaround, installing the `gstreamer0.10-plugins-base` package
|
|
||||||
should help.
|
|
||||||
* https://github.com/The-Compiler/qutebrowser/issues/7[Occasional segfaults
|
|
||||||
when quitting] - if you can reliably reproduce this, I need your help!
|
|
||||||
|
|
||||||
What to do now
|
What to do now
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
* View the http://qutebrowser.org/img/cheatsheet-big.png[keybinding cheatsheet]
|
||||||
|
to make yourself familiar with the keybindings: +
|
||||||
|
image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser keybinding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
|
||||||
* If you just cloned the repository, you'll need to run
|
* If you just cloned the repository, you'll need to run
|
||||||
`scripts/asciidoc2html.py` to generate the documentation.
|
`scripts/asciidoc2html.py` to generate the documentation.
|
||||||
* Press `:` to get the commandline. Press `o`/`O` to open a new page (with `O`
|
|
||||||
in a new tab). Use `H` and `L` to go back/forward and `J`/`K` to focus the
|
|
||||||
next/previous tab. See `~/.config/qutebrowser/keys.conf` for all mapped keys.
|
|
||||||
* Subscribe to
|
* Subscribe to
|
||||||
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist]
|
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist]
|
||||||
where there are weekly "what's new in qutebrowser" posts.
|
where there are weekly "what's new in qutebrowser" posts.
|
||||||
|
Loading…
Reference in New Issue
Block a user