From 7e36310e8a843a72690adbb88c79b209463f37e8 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Fri, 21 Jul 2017 13:18:20 +0200 Subject: [PATCH] Shorten and update README --- README.asciidoc | 278 ++++++++--------------------------- doc/help/commands.asciidoc | 2 +- doc/help/settings.asciidoc | 2 +- scripts/asciidoc2html.py | 2 - scripts/dev/ci/travis_run.sh | 1 - scripts/dev/src2asciidoc.py | 38 +---- 6 files changed, 61 insertions(+), 262 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index 8be36e2bf..1604b85ec 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -36,11 +36,8 @@ Downloads --------- See the https://github.com/qutebrowser/qutebrowser/releases[github releases -page] for available downloads (currently a source archive, and standalone -packages as well as MSI installers for Windows). - -See link:INSTALL.asciidoc[INSTALL] for detailed instructions on how to get -qutebrowser running for various platforms. +page] for available downloads and the link:INSTALL.asciidoc[INSTALL] file for +detailed instructions on how to get qutebrowser running on various platforms. Documentation ------------- @@ -98,11 +95,16 @@ Requirements The following software and libraries are required to run qutebrowser: -* http://www.python.org/[Python] 3.4 or newer (3.5 recommended) -* http://qt.io/[Qt] 5.2.0 or newer (5.9 recommended) -* QtWebKit (old or link:https://github.com/annulen/webkit/wiki[reloaded]/NG) or QtWebEngine +* http://www.python.org/[Python] 3.4 or newer (3.6 recommended) - note that + Python 3.4 support will be dropped soon. +* http://qt.io/[Qt] 5.2.0 or newer (5.9 recommended) - note that support for Qt + < 5.7.1 will be dropped soon. +* QtWebKit (old or link:https://github.com/annulen/webkit/wiki[reloaded]/NG) or + QtWebEngine. Note that support for legacy QtWebKit (before 5.212) will be + dropped soon. * http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2.0 or newer -(5.9 recommended) for Python 3 +(5.9 recommended) for Python 3. Note that support for PyQt < 5.7 will be dropped +soon. * https://pypi.python.org/pypi/setuptools/[pkg_resources/setuptools] * http://fdik.org/pyPEG/[pyPEG2] * http://jinja.pocoo.org/[jinja2] @@ -110,15 +112,14 @@ The following software and libraries are required to run qutebrowser: * http://pyyaml.org/wiki/PyYAML[PyYAML] * http://pyopengl.sourceforge.net/[PyOpenGL] when using QtWebEngine -The following libraries are optional and provide a better user experience: +The following libraries are optional: -* http://cthedot.de/cssutils/[cssutils] - -To generate the documentation for the `:help` command, when using the git -repository (rather than a release), http://asciidoc.org/[asciidoc] is needed. - -On Windows, https://pypi.python.org/pypi/colorama/[colorama] is needed to -display colored log output. +* http://cthedot.de/cssutils/[cssutils] (for an improved `:download --mhtml` + with QtWebKit) +* On Windows, https://pypi.python.org/pypi/colorama/[colorama] for colored log + output. +* http://asciidoc.org/[asciidoc] to generate the documentation for the `:help` + command, when using the git repository (rather than a release). See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser and its dependencies. @@ -142,222 +143,59 @@ get in touch! Authors ------- -Contributors, sorted by the number of commits in descending order: +qutebrowser's primary author is Florian Bruhin (The Compiler), but qutebrowser +wouldn't be what it is without the help of +https://github.com/qutebrowser/qutebrowser/graphs/contributors[hundreds of contributors]! -// QUTE_AUTHORS_START -* Florian Bruhin -* Daniel Schadt -* Ryan Roden-Corrent -* Jan Verbeek -* Jakub Klinkovský -* Antoni Boucher -* Lamar Pavel -* Marshall Lochbaum -* Bruno Oliveira -* thuck -* Martin Tournoij -* Imran Sobir -* Alexander Cogneau -* Felix Van der Jeugt -* Daniel Karbach -* Kevin Velghe -* Raphael Pierzina -* Jay Kamat -* Joel Torstensson -* Patric Schmitz -* Fritz Reichwald -* Tarcisio Fedrizzi -* Claude -* Philipp Hansch -* Corentin Julé -* meles5 -* Panagiotis Ktistakis -* Artur Shaik -* Nathan Isom -* Thorsten Wißmann -* Austin Anderson -* Jimmy -* Iordanis Grigoriou -* Niklas Haas -* Maciej Wołczyk -* Clayton Craft -* sandrosc -* Alexey "Averrin" Nabrodov -* pkill9 -* nanjekyejoannah -* avk -* ZDarian -* Milan Svoboda -* John ShaggyTwoDope Jenkins -* Peter Vilim -* Jacob Sword -* knaggita -* Yashar Shahi -* Oliver Caldwell -* Nikolay Amiantov -* Marius -* Julian Weigt -* Tomasz Kramkowski -* Sebastian Frysztak -* Julie Engel -* Jonas Schürmann -* error800 -* Michael Hoang -* Liam BEGUIN -* Daniel Fiser -* skinnay -* Zach-Button -* Samuel Walladge -* Peter Rice -* Ismail S -* Halfwit -* David Vogt -* Claire Cavanaugh -* Christian Helbling -* rikn00 -* kanikaa1234 -* haitaka -* Nick Ginther -* Michał Góral -* Michael Ilsaas -* Martin Zimmermann -* Link -* Jussi Timperi -* Cosmin Popescu -* Brian Jackson -* sbinix -* rsteube -* neeasade -* jnphilipp -* Yannis Rohloff -* Tobias Patzl -* Stefan Tatschner -* Samuel Loury -* Peter Michely -* Panashe M. Fundira -* Lucas Hoffmann -* Larry Hynes -* Kirill A. Shutemov -* Johannes Altmanninger -* Jeremy Kaplan -* Ismail -* Edgar Hipp -* Daryl Finlay -* arza -* adam -* Samir Benmendil -* Regina Hug -* Penaz -* Matthias Lisin -* Mathias Fussenegger -* Marcelo Santos -* Marcel Schilling -* Joel Bradshaw -* Jean-Louis Fuchs -* Franz Fellner -* Eric Drechsel -* zwarag -* xd1le -* rmortens -* oniondreams -* issue -* haxwithaxe -* evan -* dylan araps -* caveman -* addictedtoflames -* Xitian9 -* Vasilij Schneidermann -* Tomas Orsava -* Tom Janson -* Tobias Werth -* Tim Harder -* Thiago Barroso Perrotta -* Steve Peak -* Sorokin Alexei -* Simon Désaulniers -* Rok Mandeljc -* Noah Huesser -* Moez Bouhlel -* MikeinRealLife -* Lazlow Carmichael -* Kevin Wang -* Ján Kobezda -* Justin Partain -* Johannes Martinsson -* Jean-Christophe Petkovich -* Helen Sherwood-Taylor -* HalosGhost -* Gregor Pohl -* Eivind Uggedal -* Dietrich Daroch -* Derek Sivers -* Daniel Lu -* Daniel Jakots -* Daniel Hahler -* Arseniy Seroka -* Anton Grensjö -* Andy Balaam -* Andreas Fischer -* Amos Bird -* Akselmo -// QUTE_AUTHORS_END - -The following people have contributed graphics: +Additionally, the following people have contributed graphics: * Jad/link:http://yelostudio.com[yelo] (new icon) * WOFall (original icon) * regines (key binding cheatsheet) -Thanks / Similar projects -------------------------- +Also, thanks to everyone who contributed to one of qutebrowser's +link:doc/backers.asciidoc[crowdfunding campaigns]! -Many projects with a similar goal as qutebrowser exist: - -* http://portix.bitbucket.org/dwb/[dwb] (C, GTK+ with WebKit1, currently -http://www.reddit.com/r/linux/comments/2huqbc/dwb_abandoned/[unmaintained] - -main inspiration for qutebrowser) -* https://github.com/fanglingsu/vimb[vimb] (C, GTK+ with WebKit1, active) -* http://sourceforge.net/p/vimprobable/wiki/Home/[vimprobable] (C, GTK+ with -WebKit1, dead) -* http://surf.suckless.org/[surf] (C, GTK+ with WebKit1, active) -* https://mason-larobina.github.io/luakit/[luakit] (C/Lua, GTK+ with -WebKit1, not very active) -* http://pwmt.org/projects/jumanji/[jumanji] (C, GTK+ with WebKit1, not very -active) -* http://www.uzbl.org/[uzbl] (C, GTK+ with WebKit1/WebKit2, active) -* http://conkeror.org/[conkeror] (Javascript, Emacs-like, XULRunner/Gecko, -active) -* https://github.com/AeroNotix/lispkit[lispkit] (quite new, lisp, GTK+ with -WebKit, active) -* http://www.vimperator.org/[Vimperator] (Firefox addon) -* http://5digits.org/pentadactyl/[Pentadactyl] (Firefox addon) -* https://github.com/akhodakivskiy/VimFx[VimFx] (Firefox addon) -* https://github.com/1995eaton/chromium-vim[cVim] (Chrome/Chromium addon) -* http://vimium.github.io/[vimium] (Chrome/Chromium addon) -* https://chrome.google.com/webstore/detail/vichrome/gghkfhpblkcmlkmpcpgaajbbiikbhpdi?hl=en[ViChrome] (Chrome/Chromium addon) -* https://github.com/jinzhu/vrome[Vrome] (Chrome/Chromium addon) +Similar projects +---------------- +Many projects with a similar goal as qutebrowser exist. Most of them were inspirations for qutebrowser in some way, thanks for that! -Thanks as well to the following projects and people for helping me with -problems and helpful hints: +Active +~~~~~~ -* http://eric-ide.python-projects.org/[eric5] / Detlev Offenbach -* https://code.google.com/p/devicenzo/[devicenzo] -* portix -* seir -* nitroxleecher +* https://github.com/fanglingsu/vimb[vimb] (C, GTK+ with WebKit2) +* https://mason-larobina.github.io/luakit/[luakit] (C/Lua, GTK+ with WebKit2) +* http://surf.suckless.org/[surf] (C, GTK+ with WebKit1/WebKit2) +* http://www.uzbl.org/[uzbl] (C, GTK+ with WebKit1/WebKit2) +* Chrome/Chromium addons: + https://github.com/1995eaton/chromium-vim[cVim], + http://vimium.github.io/[Vimium], + https://github.com/brookhong/Surfingkeys[Surfingkeys], + https://github.com/lusakasa/saka-key[Saka Key] +* Firefox addons (based on WebExtensions): + https://addons.mozilla.org/en-GB/firefox/addon/vimium-ff/[Vimium-FF] (experimental), + https://github.com/lusakasa/saka-key[Saka Key] -Also, thanks to: +Inactive +~~~~~~~~ -* Everyone contributing to the link:doc/backers.asciidoc[crowdfunding]. -* Everyone who had the patience to test qutebrowser before v0.1. -* Everyone triaging/fixing my bugs in the -https://bugreports.qt.io/secure/Dashboard.jspa[Qt bugtracker] -* Everyone answering my questions on http://stackoverflow.com/[Stack Overflow] -and in IRC. -* All the projects which were a great help while developing qutebrowser. +* http://portix.bitbucket.org/dwb/[dwb] (C, GTK+ with WebKit1, +http://www.reddit.com/r/linux/comments/2huqbc/dwb_abandoned/[unmaintained] - +main inspiration for qutebrowser) +* http://sourceforge.net/p/vimprobable/wiki/Home/[vimprobable] (C, GTK+ with + WebKit1) +* http://pwmt.org/projects/jumanji/[jumanji] (C, GTK+ with WebKit1) +* http://conkeror.org/[conkeror] (Javascript, Emacs-like, XULRunner/Gecko) +* Firefox addons (not based on WebExtensions or no recent activity): + http://www.vimperator.org/[Vimperator], + http://5digits.org/pentadactyl/[Pentadactyl] + https://github.com/akhodakivskiy/VimFx[VimFx] (Firefox addon), + https://github.com/shinglyu/QuantumVim[QuantumVim] +* Chrome/Chromium addons: + https://chrome.google.com/webstore/detail/vichrome/gghkfhpblkcmlkmpcpgaajbbiikbhpdi?hl=en[ViChrome], + https://github.com/jinzhu/vrome[Vrome] License ------- diff --git a/doc/help/commands.asciidoc b/doc/help/commands.asciidoc index 05bf3ad93..2c77b0b76 100644 --- a/doc/help/commands.asciidoc +++ b/doc/help/commands.asciidoc @@ -1,5 +1,5 @@ // DO NOT EDIT THIS FILE DIRECTLY! -// It is autogenerated from docstrings by running: +// It is autogenerated by running: // $ python3 scripts/dev/src2asciidoc.py = Commands diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc index b038d462d..9ba64aecc 100644 --- a/doc/help/settings.asciidoc +++ b/doc/help/settings.asciidoc @@ -1,5 +1,5 @@ // DO NOT EDIT THIS FILE DIRECTLY! -// It is autogenerated from docstrings by running: +// It is autogenerated by running: // $ python3 scripts/dev/src2asciidoc.py = Settings diff --git a/scripts/asciidoc2html.py b/scripts/asciidoc2html.py index 39695bd23..6c7fdaf6e 100755 --- a/scripts/asciidoc2html.py +++ b/scripts/asciidoc2html.py @@ -280,8 +280,6 @@ def main(colors=False): "asciidoc.py. If not given, it's searched in PATH.", nargs=2, required=False, metavar=('PYTHON', 'ASCIIDOC')) - parser.add_argument('--no-authors', help=argparse.SUPPRESS, - action='store_true') args = parser.parse_args() try: os.mkdir('qutebrowser/html/doc') diff --git a/scripts/dev/ci/travis_run.sh b/scripts/dev/ci/travis_run.sh index 6e148c088..80a45026a 100644 --- a/scripts/dev/ci/travis_run.sh +++ b/scripts/dev/ci/travis_run.sh @@ -4,7 +4,6 @@ if [[ $DOCKER ]]; then docker run --privileged -v $PWD:/outside -e QUTE_BDD_WEBENGINE=$QUTE_BDD_WEBENGINE -e DOCKER=$DOCKER qutebrowser/travis:$DOCKER else args=() - [[ $TESTENV == docs ]] && args=('--no-authors') [[ $TRAVIS_OS_NAME == osx ]] && args=('--qute-bdd-webengine' '--no-xvfb') tox -e $TESTENV -- "${args[@]}" diff --git a/scripts/dev/src2asciidoc.py b/scripts/dev/src2asciidoc.py index a202edeb3..5fe6af6ba 100755 --- a/scripts/dev/src2asciidoc.py +++ b/scripts/dev/src2asciidoc.py @@ -27,7 +27,6 @@ import shutil import os.path import inspect import subprocess -import collections import tempfile import argparse @@ -44,7 +43,7 @@ from qutebrowser.utils import docutils, usertypes FILE_HEADER = """ // DO NOT EDIT THIS FILE DIRECTLY! -// It is autogenerated from docstrings by running: +// It is autogenerated by running: // $ python3 scripts/dev/src2asciidoc.py """.lstrip() @@ -421,32 +420,6 @@ def generate_settings(filename): _generate_setting_section(f, sectname, sect) -def _get_authors(): - """Get a list of authors based on git commit logs.""" - corrections = { - 'binix': 'sbinix', - 'Averrin': 'Alexey "Averrin" Nabrodov', - 'Alexey Nabrodov': 'Alexey "Averrin" Nabrodov', - 'Michael': 'Halfwit', - 'Error 800': 'error800', - 'larryhynes': 'Larry Hynes', - 'Daniel': 'Daniel Schadt', - 'Alexey Glushko': 'haitaka', - 'Corentin Jule': 'Corentin Julé', - 'Claire C.C': 'Claire Cavanaugh', - 'Rahid': 'Maciej Wołczyk', - 'Fritz V155 Reichwald': 'Fritz Reichwald', - 'Spreadyy': 'sandrosc', - } - ignored = ['pyup-bot'] - commits = subprocess.check_output(['git', 'log', '--format=%aN']) - authors = [corrections.get(author, author) - for author in commits.decode('utf-8').splitlines() - if author not in ignored] - cnt = collections.Counter(authors) - return sorted(cnt, key=lambda k: (cnt[k], k), reverse=True) - - def _format_block(filename, what, data): """Format a block in a file. @@ -493,12 +466,6 @@ def _format_block(filename, what, data): shutil.move(tmpname, filename) -def regenerate_authors(filename): - """Re-generate the authors inside README based on the commits made.""" - data = ['* {}\n'.format(author) for author in _get_authors()] - _format_block(filename, 'authors', data) - - def regenerate_manpage(filename): """Update manpage OPTIONS using an argparse parser.""" # pylint: disable=protected-access @@ -544,9 +511,6 @@ def main(): generate_settings('doc/help/settings.asciidoc') print("Generating command help...") generate_commands('doc/help/commands.asciidoc') - if '--no-authors' not in sys.argv: - print("Generating authors in README...") - regenerate_authors('README.asciidoc') if '--cheatsheet' in sys.argv: print("Regenerating cheatsheet .pngs") regenerate_cheatsheet()