Merge pull request #25 from 5t111111/fix-when-space-in-filepath

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index e32260d77449e46c31405ce5d26d83d88405e9f4..f84055baa03b30179628af15d0a53d88cb10bea8 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -5,14 +5,16 @@ a static syntax and style checker for Python source code.  It supersedes both
 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
 [vim-pep8](https://github.com/nvie/vim-pep8).
 
 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
 [vim-pep8](https://github.com/nvie/vim-pep8).
 

-Flake8 is a wrapper around PyFlakes (static syntax checker), PEP8 (style
-checker) and Ned's MacCabe script (complexity checker).
+[Flake8](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes 
+(static syntax checker), PEP8 (style checker) 
+and Ned's MacCabe script (complexity checker).

 
 
 Installation
 ------------
 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
 
 
 Installation
 ------------
 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using

-it already.  Then, simply put the contents of this repository in your
+it already.  Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package.
+Then, simply put the contents of this repository in your

 `~/.vim/bundle` directory.
 
 Usage
 `~/.vim/bundle` directory.
 
 Usage


@@ -32,6 +34,10 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 

+To add builtins, in your .vimrc:
+
+    let g:flake8_builtins="_,apply"
+

 To ignore errors, in your .vimrc:
 
     let g:flake8_ignore="E501,W293"
 To ignore errors, in your .vimrc:
 
     let g:flake8_ignore="E501,W293"


@@ -44,7 +50,7 @@ To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_
 
     let g:flake8_max_complexity=10
 
 
     let g:flake8_max_complexity=10
 

-To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
+To customize the location of your flake8 binary, set `g:flake8_cmd`:

 
     let g:flake8_cmd="/opt/strangebin/flake8000"
 
 
     let g:flake8_cmd="/opt/strangebin/flake8000"
 


@@ -61,3 +67,22 @@ This plugin goes well together with the following plugin:
 
 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
   and `<F9>`)
 
 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
   and `<F9>`)

+
+
+History
+-------
+
+1.3: Added the following options:
+
+     - `g:flake8_builtins="_,apply"`
+     - `g:flake8_max_complexity=10`
+
+1.2: Added the following options:
+
+     - `g:flake8_cmd="/opt/strangebin/flake8000"`
+     - `g:flake8_max_line_length=120`
+     - `g:flake8_ignore="E501,W293"`
+
+1.1: Added `g:flake8_ignore` option.
+
+1.0: Initial version.