git.r.bdr.sh - rbdr/dotfiles/blob - atom/packages/vim-mode/README.md

   1 ## Vim Mode package [![Build Status](https://travis-ci.org/atom/vim-mode.svg?branch=master)](https://travis-ci.org/atom/vim-mode)
   2
   3 Provides vim modal control for Atom, ideally blending the best of vim
   4 and Atom.
   5
   6 ### Installing
   7
   8 Use the Atom package manager, which can be found in the Settings view or
   9 run `apm install vim-mode` from the command line.
  10
  11 ### Current Status
  12
  13 Sizable portions of Vim's command mode work as you'd expect, including
  14 many complex combinations. Even so, this package is far from finished (Vim
  15 wasn't built in a day).
  16
  17 If you want the vim ex line (for `:w`, `:s`, etc.), you can try [ex-mode](https://atom.io/packages/ex-mode)
  18 which works in conjuction with this plugin.
  19
  20 Currently, vim-mode requires soft line wraps to be disabled, and has some issues
  21 with international keyboard layouts.
  22
  23 If there's a feature of Vim you're missing, it might just be that you use it
  24 more often than other developers. Adding a feature can be quick and easy. Check
  25 out the [closed pull requests](https://github.com/atom/vim-mode/pulls?direction=desc&page=1&sort=created&state=closed)
  26 to see examples of community contributions. We're looking forward to yours, too.
  27
  28 ### Documentation
  29
  30 * [Overview](https://github.com/atom/vim-mode/blob/master/docs/overview.md)
  31 * [Motions](https://github.com/atom/vim-mode/blob/master/docs/motions.md)
  32 * [Operators](https://github.com/atom/vim-mode/blob/master/docs/operators.md)
  33 * [Windows](https://github.com/atom/vim-mode/blob/master/docs/windows.md)
  34 * [Scrolling](https://github.com/atom/vim-mode/blob/master/docs/scrolling.md)
  35
  36 ### Development
  37
  38 * Create a branch with your feature/fix.
  39 * Add a spec (take inspiration from the ones that are already there).
  40 * If you're adding a command be sure to update the appropriate file in
  41   `docs/`
  42 * Create a PR.
  43
  44 When in doubt, open a PR earlier rather than later so that you can receive
  45 feedback from the community. We want to get your fix or feature included as much
  46 as you do.
  47
  48 See [the contribution guide](https://github.com/atom/vim-mode/blob/master/CONTRIBUTING.md).