documentation/README.md

   1 # VimFx documentation
   2
   3 Copyright Simon Lydell 2015, 2016.
   4
   5 Permission is granted to copy, distribute and/or modify this document
   6 under the terms of the GNU Free Documentation License, Version 1.3
   7 or any later version published by the Free Software Foundation;
   8 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
   9 A copy of the license is included in the file ["GNU Free Documentation
  10 License"](GNU%20Free%20Documentation%20License).
  11
  12 ## Contents
  13
  14 - [Questions & Answers](questions-and-answers.md)
  15   **– New to VimFx? Look here!**
  16
  17 - [Install VimFx](installation.md)
  18   – Click a button or build it from source.
  19
  20 - [Options](options.md)
  21   – All of VimFx’s _options_ listed and explained in one place.
  22
  23 - [Styling](styling.md)
  24   – Customize the looks of VimFx, such as hint marker font size.
  25
  26 - [Modes](modes.md)
  27   – An introduction to VimFx’s _modes._
  28
  29 - [Commands](commands.md)
  30   – Extra details about some of VimFx’s _commands._
  31
  32 - [Shortcuts](shortcuts.md)
  33   – How the keyboard _shortcuts_ for commands work.
  34
  35 - [Button](button.md)
  36   – Details of VimFx’s toolbar button. ![button-icon]
  37
  38 - [Notifications](notifications.md)
  39   – How VimFx sometimes talks to you.
  40
  41 - [Handy standard Firefox features](handy-standard-firefox-features.md)
  42   – Tips and tricks that are standard Firefox stuff, but very useful to VimFx.
  43
  44 Also check out the [wiki](https://github.com/akhodakivskiy/VimFx/wiki)!
  45
  46 [button-icon]: ../extension/skin/icon16.png
  47
  48 ### For advanced users
  49
  50 - [Config file](config-file.md)
  51   – Add custom commands and customize VimFx using a text file.
  52
  53 - [API](api.md)
  54   – The API available for config files.
  55
  56 ### For contributors
  57
  58 - [Contributing code](CONTRIBUTING-CODE.md)
  59   – How to, and tips for getting your pull request merged faster.
  60
  61 - [Tools](tools.md)
  62   – Automation for building and maintaining VimFx.