documentation/installation.md

   1 # Installation
   2
   3 Independently from the installation method chosen, you need Firefox version 68+
   4 (or a compatible fork) and the [LegacyFox] shim. Both options are unsigned and
   5 don't offer automatic updates. You may want to *watch releases* on GitHub.
   6
   7 [LegacyFox]: https://git.gir.st/LegacyFox.git
   8
   9
  10 ## Option 1: [GitHub releases][releases]
  11
  12 Go to VimFx’s [releases] page and click the link to “VimFx.xpi” for the version
  13 you’re interested in (most likely the latest). Firefox should then ask you about
  14 allowing the installation. (If not, download the .xpi file and [open it in
  15 Firefox][open-xpi].)
  16
  17 [releases]: https://github.com/akhodakivskiy/VimFx/releases
  18
  19
  20 ## Option 2: Build from source
  21
  22 [Build VimFx] and then [open the produced `build/VimFx.xpi` file][open-xpi].
  23
  24 - Bleeding edge.
  25 - Allows you to fiddle with the code.
  26
  27 [Build VimFx]: tools.md#how-to-build-and-install-the-latest-version-from-source
  28
  29 ### How to install an .xpi file in Firefox
  30
  31 Firefox add-ons are .xpi files (a renamed .zip file—try renaming it to .zip and
  32 open it like any old .zip file to see what’s inside). There are several ways of
  33 installing them:
  34
  35 - Drag and drop the .xpi file into the Firefox window.
  36 - Press ctrl+o and choose the .xpi file.
  37 - Use “Install from file…” in the top-right menu in the Add-ons Manager.
  38
  39
  40 [open-xpi]: #how-to-install-an-xpi-file-in-firefox