Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: update more detailed contributing info #80

Merged
merged 1 commit into from
Dec 2, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
[![Build Status](https://travis-ci.org/VSCodeVim/Vim.svg?branch=master)](https://travis-ci.org/VSCodeVim/Vim) [![Build status](https://ci.appveyor.com/api/projects/status/0t6ljij7g5h0ddx8?svg=true)](https://ci.appveyor.com/project/guillermooo/vim) [![Slack Status](http://slackin.westus.cloudapp.azure.com/badge.svg)](http://slackin.westus.cloudapp.azure.com)

# Vim

Vim emulation for Visual Studio Code.
[![Build Status](https://travis-ci.org/VSCodeVim/Vim.svg?branch=master)](https://travis-ci.org/VSCodeVim/Vim) [![Build status](https://ci.appveyor.com/api/projects/status/0t6ljij7g5h0ddx8?svg=true)](https://ci.appveyor.com/project/guillermooo/vim) [![Slack Status](http://slackin.westus.cloudapp.azure.com/badge.svg)](http://slackin.westus.cloudapp.azure.com)

Vim (aka. VSCodeVim) is a [Visual Studio Code](https://code.visualstudio.com/) extension that enabling the use of the Vim keybinding experience within Visual Studio Code.

![Screenshot](images/screen.png)

## Installation
## Install

1. Install [Visual Studio Code](https://code.visualstudio.com/)
2. Open the command palette (`Ctrl-Shift-P` or `Cmd-Shift-P`) select `Install Extension` and search for **vim**. Alternatively, run `ext install vim`
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`

## Project Status

See our [release notes](https://github.com/VSCodeVim/Vim/releases) for full details.

### Completed

* Modes:
Expand All @@ -29,34 +31,34 @@ Vim emulation for Visual Studio Code.
* Editing: `u`, `ctrl+r`
* File Operations: `:q`, `:w`

### Planned
## Contributing

In no particular order:
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.

* Search: `/`
* Support Macros
* Buffers
* Neovim Integration
### Developing

## Contributions
1. Install prerequisites:
* latest [Visual Studio Code](https://code.visualstudio.com/)
* [Node.js](https://nodejs.org/) v4.0.0 or higher
2. Fork and clone the repo, then

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.
```
$ npm install
$ npm install -g gulp
$ gulp init
```

3. Open the folder in VS Code

#### Submitting a PR

### Getting started
You've made some changes, and you are ready to submit a PR? Please make sure:

1. Install [Visual Studio Code](https://code.visualstudio.com/).
2. Install [Node.js](https://nodejs.org/) with version > 4.0.0.
3. Fork the repo.
4. `npm install`
5. `gulp init`
* This step will install type definitions (using [tsd](http://definitelytyped.org/tsd/)).
6. Create a topic branch.
7. Ensure tests pass:
1. Tests pass:
* `gulp`: run tslint and tests
* [Launch tests within VS Code](https://code.visualstudio.com/docs/extensions/testing-extensions)
8. Squash your commits.
9. Submit your PR.
2. Commits are squashed

## License

Expand Down