~sotirisp/qute-gemini

896d91aca8d8d57caeb8ac3c84e0f255007a5bed — Sotiris Papatheodorou 8 months ago c0b00ac
Update keybinding recommendation
1 files changed, 12 insertions(+), 10 deletions(-)

M README.md
M README.md => README.md +12 -10
@@ 12,21 12,24 @@ thanks to its authors!
## Installation

1. Copy `qute-gemini` and `qute-gemini-tab` into
`~/.local/share/qutebrowser/userscripts/`.
   `~/.local/share/qutebrowser/userscripts/`.

2. Add the following lines to `~/.config/qutebrowser/config.py`
2. Set custom keybinding for opening Gemini URLs by adding the following lines
   to `~/.config/qutebrowser/config.py`:

    ``` python
    config.bind('f', 'hint links userscript qute-gemini')
    config.bind('F', 'hint links userscript qute-gemini-tab')
    # Open in the current tab
    config.bind(';g', 'hint links userscript qute-gemini')
    # Open in a new tab
    config.bind(';G', 'hint links userscript qute-gemini-tab')
    ```

    The script only processes `gemini://` URLs and opens all other URLs using
    qutebrowser, so it should be safe to replace the default hint keybindings.
    qutebrowser, so opening a non-`gemini://` should also work.

3. Re-source the qutebrowser config and visit the
[Gemini spec homepage](gemini://gemini.circumlunar.space)
to ensure that everything works.
3. Re-source the qutebrowser config or restart qutebrowser and visit the
   [Gemini spec homepage](gemini://gemini.circumlunar.space)
   to ensure that everything works.





@@ 34,7 37,6 @@ to ensure that everything works.

- Userscript limitations
    - Only `text/gemini` content is shown.
    - Probably tons of usability issues.
- Qutebrowser limitations
    - Opening `gemini://` URLs by clicking on them does not work, only opening
      them via the keybinding is possible.


@@ 53,6 55,6 @@ will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 

gcat is distributed under the BSD 2-Clause license.