g:flake8_builtins to pass --builtins to flake8.py

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index fcfbab2407cc85d2edf985c7f1ea3f9b70624e8c..7a01cf82205517ce73b65bdc7214ae26fa44a88a 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -1,10 +1,20 @@
-vim-flake8 ![Project status](http://stillmaintained.com/nvie/vim-flake8.png)
+vim-flake8
 ==========
+`vim-flake8` is a Vim plugin that runs the currently open file through Flake8,
+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).
+
+[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
-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
@@ -24,6 +34,26 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
     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"
+
+If you want to change the max line length for PEP8:
+
+    let g:flake8_max_line_length=99
+
+To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued:
+
+    let g:flake8_max_complexity=10
+
+To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
+
+    let g:flake8_cmd="/opt/strangebin/flake8000"
+
 
 Tips
 ----
@@ -33,7 +63,6 @@ enable this, add the following line to your `.vimrc` file (thanks
 
     autocmd BufWritePost *.py call Flake8()
 
-
 This plugin goes well together with the following plugin:
 
 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`