X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/ca1dc6d3ef003f7e44eec46231779cb18009c88d..381686d2f1fc799f7d248993f0ac86dd96ce7bab:/README.mdown diff --git a/README.mdown b/README.mdown index 0694399..136cb4b 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 @@ -40,7 +42,11 @@ If you want to change the max line length for PEP8: let g:flake8_max_line_length=99 -To cutomize the location of your flake8 binary, set `g:flake8_cmd`: +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 customize the location of your flake8 binary, set `g:flake8_cmd`: let g:flake8_cmd="/opt/strangebin/flake8000"