Skip to content

Commit 446534a

Browse files
committed
update readme
1 parent 091ffda commit 446534a

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![WebVim](resources/WebVim.png "WebVim")
22
===============================
33

4-
WebVim is a vim based IDE for web development.
4+
WebVim is a Vim based IDE for web development.
55

66
It targets :
77
- JavaScript development (ES5, ES6, node.js)
@@ -17,7 +17,7 @@ And contains the features you expect from a modern code editor :
1717
- git support
1818
- code format
1919
- support coding conventions (editorconfig)
20-
- hardcore mode (for real vim users)
20+
- hardcore mode (for real Vim users)
2121
- jsdoc generation (coming soon)
2222
- debugging (coming soon)
2323
- grunt/gulp support (coming soon)
@@ -30,7 +30,7 @@ __Only tested on linux__ (Ubuntu and Debian)
3030

3131
### Dependencies
3232

33-
1. A modern version of vim
33+
1. A modern version of Vim
3434

3535
apt-get install vim vim-runtime vim-gui-common
3636

@@ -57,19 +57,19 @@ or compile a recent version with `xterm_clipboard` and `ruby` or `python` suppor
5757

5858
## Hardcore mode
5959

60-
The hardcore mode remap some keys to force you use vim in a productive way:
61-
- no arrow keys for moving instead use the common vim movement commands.
60+
The hardcore mode remap some keys to force you use Vim in a productive way:
61+
- no arrow keys for moving instead use the common Vim movement commands.
6262
- in insert mode, use `jk` to switch back to normal mode instead of `<esc>`
6363

64-
Restricting commands is the best way to make your fingers learn. After one or two days, you should be more productive and have learned lots of vim commands.
64+
Restricting commands is the best way to make your fingers learn. After one or two days, you should be more productive and have learned lots of Vim commands.
6565

6666
You can disable the hardcore mode by setting the value of `g:hardcoreMode` to `0` in `.vimrc`. You can also change the mappings.
6767

6868
## Usage
6969

7070
### Vim
7171

72-
WebVim is only a Vim distribution with plugins and configuration, so all common Vim commands and basic mapping are available. You must know how to use vim before using this IDE. If you're not comfortable with Vim enough I suggest you to take the interactive Vim tutorial (run `vimtutor` in a terminal), and keep a [common usage cheat sheet](http://fprintf.net/vimCheatSheet.html) close to you until your fingers get all the mappings in memory.
72+
WebVim is only a Vim distribution with plugins and configuration, so all common Vim commands and basic mapping are available. You must know how to use Vim before using this IDE. If you're not comfortable with Vim enough I suggest you to take the interactive Vim tutorial (run `vimtutor` in a terminal), and keep a [common usage cheat sheet](http://fprintf.net/vimCheatSheet.html) close to you until your fingers get all the mappings in memory.
7373

7474
### WebVim
7575

@@ -186,10 +186,10 @@ _Modes_ :
186186
- `v` visual
187187

188188
_Commands_ :
189-
- `:command` a vim command
189+
- `:command` a Vim command
190190
- `:set somthing` can also be replaced by `:setlocal something` to apply it to the current buffer only
191191
- `<c-m>a` or `a` a keyboard command
192-
- `<c-/>` means `CTRL and `/` (this is the vim notation)
192+
- `<c-/>` means `CTRL and `/` (this is the Vim notation)
193193
- `<s-left>` means `Shift` and `left arrow`
194194
- `<c-a>b` means `CTRL` and `a`, then `b`
195195
- `<leader>` is mapped to `,`
@@ -242,13 +242,14 @@ WebVim is only a distribution that contains plugins. The plugin authors have mad
242242
## History
243243

244244
- __1.0.0__ Becomes `webvim` with an install process, a better configuration system, better plugins neighborhood
245-
- __0.1.0__ A basic `dotvim` repository with my own vim configuration
245+
- __0.1.0__ A basic `dotvim` repository with my own Vim configuration
246246

247247
## Contributing
248248

249249
Every contribution is more than welcomed. You can:
250250
- [report issues](https://github.com/krampstudio/webvim/issues)
251-
- Fix, improve the configuration, add new features. The best is to fork and submit a pull request.
251+
- Fix, improve the configuration, add new features. The best is to fork and submit a pull request
252+
- Test and adapt to other OS
252253
- Fix my English mistakes
253254
- Update the documentation
254255
- Create a better logo

0 commit comments

Comments
 (0)