Mentioned g:flake8_cmd (#9) in README

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index fcfbab2407cc85d2edf985c7f1ea3f9b70624e8c..99ef175da759223f5c3c0eb06d68dda1261ba106 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -1,5 +1,13 @@
-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 is a wrapper around PyFlakes (static syntax checker), PEP8 (style
+checker) and Ned's MacCabe script (complexity checker).
+
 
 Installation
 ------------
@@ -33,6 +41,13 @@ enable this, add the following line to your `.vimrc` file (thanks
 
     autocmd BufWritePost *.py call Flake8()
 
+To ignore errors, in your .vimrc:
+
+    let g:flake8_ignore="E501,W293"
+
+If you want to cutomize the location of your flake8 binary, set `g:flake8_cmd`:
+
+    let g:flake8_cmd="/opt/strangebin/flake8000"
 
 This plugin goes well together with the following plugin: