From: Vincent Driessen Date: Mon, 13 Feb 2012 09:28:07 +0000 (+0100) Subject: Add a little introduction for this plugin. X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/80338e1657cb1369479d7da0b4fe09200ffeb34d?ds=sidebyside;hp=-c;pf=etc Add a little introduction for this plugin. --- 80338e1657cb1369479d7da0b4fe09200ffeb34d diff --git a/README.mdown b/README.mdown index fcfbab2..064594b 100644 --- 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 ------------