From 4bfd5c332c0be508e3b3dbdcd80e191712d75d98 Mon Sep 17 00:00:00 2001 From: Chiel92 Date: Sun, 2 Dec 2012 15:12:04 +0100 Subject: [PATCH] readme improved --- README.markdown | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index dbdefc6..6d598bf 100644 --- a/README.markdown +++ b/README.markdown @@ -7,13 +7,25 @@ If you have installed a supported formatprogram correctly, it will integrate wit How to install (Vundle) ----------------------- - Put this in your .vimrc ```vim 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 :call g:Autoformat() +``` + + Supported formatprograms ------------------------ * einars/jsbeautify for javascript (has to be installed as a pathogen-compatible plugin)