2 This is part of the VimFx documentation.
3 Copyright Simon Lydell 2016.
4 See the file README.md for copying conditions.
9 ## Option 1: [addons.mozilla.org] \(AMO)
11 **<https://addons.mozilla.org/firefox/addon/VimFx>**
13 Follow the above link and hit the green “Install” button and you should be ready
16 - [Signed][signed] and reviewed by Mozilla.
20 [addons.mozilla.org]: https://addons.mozilla.org/
23 ## Option 2: [GitHub releases][releases]
25 Go to VimFx’s [releases] page and click the link to “VimFx.xpi” for the version
26 you’re interested in (most likely the latest). Firefox should then ask you about
27 allowing the installation. (If not, download the .xpi file and [open it in
30 - [Signed][signed] by Mozilla (but not reviewed).
31 - Available as a backup alternative, and in case of slow reviews on AMO.
32 - No automatic updates.
34 [releases]: https://github.com/akhodakivskiy/VimFx/releases
37 ## Option 3: Build from source
39 [Build VimFx] and then [open the produced `build/VimFx.xpi` file][open-xpi].
43 - Allows you to fiddle with the code.
44 - No automatic updates.
46 [Build VimFx]: tools.md#how-to-build-and-install-the-latest-version-from-source
48 ### How to install an .xpi file in Firefox
50 Firefox add-ons are .xpi files (a renamed .zip file—try renaming it to .zip and
51 open it like any old .zip file to see what’s inside). There are several ways of
54 - Drag and drop the .xpi file into the Firefox window.
55 - Press ctrl+o and choose the .xpi file.
56 - Use “Install from file…” in the top-right menu in the Add-ons Manager.
59 ## What is a signed add-on?
61 By default it is not possible to install add-ons which haven’t been signed by
62 Mozilla. In order for an add-on to be signed it must pass some code checks. The
63 idea is to protect users from malware.
65 If you’re interested in installing an unsigned add-on (such as if you’ve built
66 a VimFx .xpi from source yourself), read all about extension signing here:
68 <https://wiki.mozilla.org/Addons/Extension_Signing>
71 [open-xpi]: #how-to-install-an-xpi-file-in-firefox
72 [signed]: #what-is-a-signed-add-on