Vim/README.md

42 lines
1.9 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/VSCodeVim/Vim.svg?branch=master)](https://travis-ci.org/VSCodeVim/Vim) [![Slack Status](https://vscodevim-slackin.azurewebsites.net/badge.svg)](https://vscodevim-slackin.azurewebsites.net)
2016-01-07 02:59:32 +03:00
# Vim
2016-06-23 11:53:28 +03:00
VSCodeVim is a [Visual Studio Code](https://code.visualstudio.com/) extension that provides Vim keybindings within Visual Studio Code.
**Please direct any questions about missing/incomplete features to [our Github Issues page](https://github.com/VSCodeVim/Vim/issues).** We'll do our best to get back to you quickly! We've added a lot of functionality, but everyone uses Vim in their own special way, so let us know if we're missing your favorite obscure command. :wink:
If you want to talk with us directly, drop by our Slack channel above! We hang out there and are pretty friendly :smiley:
2015-11-18 23:00:58 +03:00
2015-11-29 13:37:35 +03:00
![Screenshot](images/screen.png)
2015-11-18 23:00:58 +03:00
## Install
1. Within Visual Studio Code, open the command palette (`Ctrl-Shift-P` / `Cmd-Shift-P`)
2. Select `Install Extension` and search for 'vim' *or* run `ext install vim`
## Configure
Adjust configurations through user settings (File -> Preferences -> User Settings).
* vim.keyboardLayout:
2016-01-06 15:05:41 +03:00
* Supported Values: `en-US (QWERTY)` (default), `es-ES (QWERTY)`, `de-DE (QWERTZ)`, `da-DK (QWERTY)`
## Project Status
2016-06-23 11:53:28 +03:00
Check out our [release notes](https://github.com/VSCodeVim/Vim/releases) for more notes.
2016-06-23 21:35:47 +03:00
[Check the Roadmap](https://github.com/VSCodeVim/Vim/blob/master/ROADMAP.md) for our future plans.
2016-01-07 02:54:18 +03:00
2016-01-03 11:31:33 +03:00
## Contributing
See [here](https://github.com/VSCodeVim/Vim/blob/master/.github/CONTRIBUTING.md) for how to run a development environment and make contributions.
2016-06-05 22:00:32 +03:00
2016-06-23 21:35:47 +03:00
[Check the full list of commands](https://github.com/VSCodeVim/Vim/blob/master/ROADMAP.md) if you're having trouble thinking of things to add! :wink:
2016-06-23 12:21:54 +03:00
2016-01-03 11:31:33 +03:00
This project is maintained by a group of awesome [contributors](https://github.com/VSCodeVim/Vim/graphs/contributors). *Thank you!* :heart:
2015-11-18 23:00:58 +03:00
## License
2015-11-19 21:22:17 +03:00
2015-11-18 23:00:58 +03:00
[MIT](LICENSE.txt)