README.mdown

   1 vim-flake8 ![Project status](http://stillmaintained.com/nvie/vim-flake8.png)
   2 ==========
   3
   4 Installation
   5 ------------
   6 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
   7 it already.  Then, simply put the contents of this repository in your
   8 `~/.vim/bundle` directory.
   9
  10 Usage
  11 -----
  12 1. Open a Python file
  13 2. Press `<F7>` to run `flake8` on it
  14
  15 It shows the errors inside a quickfix window, which will allow your to quickly
  16 jump to the error locations by simply pressing [Enter].
  17
  18
  19 Customization
  20 -------------
  21 If you don't want to use the `<F7>` key for flake8-checking, simply remap it to
  22 another key.  It autodetects whether it has been remapped and won't register
  23 the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
  24
  25     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
  26
  27
  28 Tips
  29 ----
  30 A tip might be to run the Flake8 check every time you write a Python file, to
  31 enable this, add the following line to your `.vimrc` file (thanks
  32 [Godefroid](http://github.com/gotcha)!):
  33
  34     autocmd BufWritePost *.py call Flake8()
  35
  36
  37 This plugin goes well together with the following plugin:
  38
  39 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
  40   and `<F9>`)