X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/fc04a1123eb6b2aa855eddfcee6da7a04ca0408c..673b1816bc42d5673e8834af6526e733d98be96e:/README.mdown diff --git a/README.mdown b/README.mdown index e32260d..7a01cf8 100644 --- 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). -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 -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 @@ -32,6 +34,10 @@ the `` key if so. For example, to remap it to `` instead, use: autocmd FileType python map :call Flake8() +To add builtins, in your .vimrc: + + let g:flake8_builtins="_,apply" + To ignore errors, in your .vimrc: let g:flake8_ignore="E501,W293"