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