hiro/tridactyl
1
0
Fork 0
mirror of https://github.com/vale981/tridactyl synced 2025-03-05 09:31:41 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add quicklinks and minor redesign to README

Browse source
This commit is contained in:
Sayan 2020-09-30 22:10:34 +05:30 • committed by GitHub
parent 14b65660b6
commit 04135506fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
readme.md
View file

@ -1,12 +1,34 @@
![Tridactyl logo](src/static/logo/Tridactyl_200px.png)
<h1 align="center">
<br>
<img src="src/static/logo/Tridactyl_200px.png" alt="Tridactyl Logo" width="200">
<br>
Tridactyl
<br>
</h1>
# Tridactyl [![Build Status](https://travis-ci.org/tridactyl/tridactyl.svg?branch=master)](https://travis-ci.org/tridactyl/tridactyl) [![Matrix Chat][matrix-badge]][matrix-link] [![Gitter Chat][gitter-badge]][gitter-link]
<h4 align="center">Replace Firefox's default control mechanism with one modelled on the one true editor, Vim. </h4>
<p align="center">
<a href="https://travis-ci.org/tridactyl/tridactyl"><img src="https://travis-ci.org/tridactyl/tridactyl.svg?branch=master" alt="Build Status"></a>
<a href="https://gitter.im/tridactyl/Lobby"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join Gitter Chat"></a>
<a href="https://addons.mozilla.org/en-US/firefox/addon/tridactyl-vim/"><img src="https://img.shields.io/amo/users/tridactyl-vim" alt="Mozilla Addon Store"></a>
</p>
<p align="center">
<a href="#installation">Installation</a> •
<a href="#changelog">Changelog</a> •
<a href="#first-look">First Look</a> •
<a href="#highlighted-features">Features</a> •
<a href="#frequently-asked-questions">FAQ</a> •
<a href="#contributing">Contributing</a>
</p>
<br>
Replace Firefox's default control mechanism with one modelled on the one true editor, Vim.
![Gigantic GIF showing Tridactyl in action](doc/AMO_screenshots/trishowcase.gif)
## Installing
## Installation
[Simply click this link in Firefox to install our latest "beta" build][riskyclick]. If you want more options, read on.
@ -30,7 +52,7 @@ Tridactyl stable can be installed from the [Mozilla add-ons website (the AMO)][a
If you want to use advanced features such as edit-in-Vim, you'll also need to install the native messenger or executable, instructions for which can be found by typing `:installnative` and hitting enter once you are in Tridactyl. Arch users can install the [AUR package](https://aur.archlinux.org/packages/firefox-tridactyl-native/) `firefox-tridactyl-native` instead.
## Migrating between beta and stable builds
### Migrating between beta and stable builds
Our beta and stable versions store their configurations in separate places. To migrate between the two, see [the wiki](https://github.com/tridactyl/tridactyl/wiki/Migration-from-stable-to-beta).
@ -146,7 +168,7 @@ You can bind your own shortcuts in normal mode with the `:bind` command. For exa
- addons.mozilla.org is now supported so long as you run `fixamo` first.
- Tridactyl now supports changing the Firefox GUI if you have the native messenger installed via `guiset`. There's quite a few options available, but `guiset gui none` is probably what you want, perhaps followed up with `guiset tabs always`. See `:help guiset` for a list of all possible options.
## Frequently asked questions (FAQ)
## Frequently Asked Questions
- Why doesn't Tridactyl work/why does it break the websites I'm trying to use? or 'Help! A website I use is totally blank when I try to use it with Tridactyl enabled!' or 'Why doesn't Tridactyl work on some pages?'