vim/vim-autoformat
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

readme improved

Browse Source
This commit is contained in:
Chiel92 2012-12-02 15:12:04 +01:00
parent 27d0757b83
commit 4bfd5c332c
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.markdown
View File

@ -7,13 +7,25 @@ If you have installed a supported formatprogram correctly, it will integrate wit
How to install (Vundle) How to install (Vundle)
----------------------- -----------------------
Put this in your .vimrc Put this in your .vimrc
```vim ```vim
Bundle "Chiel92/vim-autoformat" Bundle "Chiel92/vim-autoformat"
``` ```
How to use
----------
To be able to use automatic code formatting, you have to install an external program that can format code of the programming language you are using.
If you have done that, you can format visually selected code with ```gq```.
For more info type ```:help gq```.
You can also format the whole buffer by calling the function ```g:Autoformat()```.
For convenience it is recommended that you assign a key for this, like so:
```vim
noremap <F7> :call g:Autoformat()<CR><CR>
```
Supported formatprograms Supported formatprograms
------------------------ ------------------------
* einars/jsbeautify for javascript (has to be installed as a pathogen-compatible plugin) * einars/jsbeautify for javascript (has to be installed as a pathogen-compatible plugin)