mirror of
https://github.com/VSCodeVim/Vim.git
synced 2024-11-09 13:34:29 +03:00
62 lines
1.9 KiB
Markdown
62 lines
1.9 KiB
Markdown
[](https://travis-ci.org/VSCodeVim/Vim) [](https://ci.appveyor.com/project/guillermooo/vim) [](http://slackin.westus.cloudapp.azure.com)
|
|
|
|
# Vim
|
|
|
|
Vim emulation for Visual Studio Code.
|
|
|
|
|
|
|
|
## Installation and Usage
|
|
|
|
1. Install [Visual Studio Code](https://code.visualstudio.com/)
|
|
2. In the command palette (`Ctrl-Shift-P` or `Cmd-Shift-P`) select `Install Extension` and search for **vim**. Alternatively, run `ext install vim`
|
|
|
|
## Project Status
|
|
|
|
### Completed
|
|
|
|
* Modes:
|
|
* Visual: `v`, `V`
|
|
* Command: `Esc`, `Ctrl+[`
|
|
* Insert: `i`, `I`, `a`, `A`, `o`, `O`
|
|
* Current Mode displayed in the status bar in the bottom left
|
|
|
|
* Commands:
|
|
* Command Palette: `:`
|
|
* Navigation: `h`, `j`, `k`, `l`
|
|
* Indentation: `>>`, `<<`
|
|
* Deletion: `dd`, `dw`, `db`
|
|
* Editing: `u`, `ctrl+r`
|
|
* File Operations: `:q`, `:w`
|
|
|
|
### Planned
|
|
|
|
In no particular order:
|
|
|
|
* Search: `/`
|
|
* Support Macros
|
|
* Buffers
|
|
* Neovim Integration
|
|
|
|
## Contributions
|
|
|
|
Contributions are extremely welcomed!
|
|
Take a look at [Extension API](https://code.visualstudio.com/docs/extensionAPI/overview) on how to get started and our current [issues](https://github.com/VSCodeVim/Vim/issues) to see what we are working on next.
|
|
|
|
### Getting started
|
|
|
|
1. Install [Visual Studio Code](https://code.visualstudio.com/).
|
|
2. Fork the repo.
|
|
3. Run `npm install` to install all the dependencies.
|
|
4. Run `tsd install` to install type definitions (using [tsd](http://definitelytyped.org/tsd/)).
|
|
5. Create a topic branch.
|
|
6. Run tests:
|
|
* Ensure tslint passes by running: `gulp`
|
|
* Ensure tests pass by running extension tests within Visual Studio Code
|
|
7. Squash your commits.
|
|
8. Submit your PR
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE.txt)
|