X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/378c25cc58d82d5f2dcfa723f2f0d91f06a29200..c6b43f88e4cbce052843e8cbd9593cc7753208fe:/README.mdown?ds=inline diff --git a/README.mdown b/README.mdown index 692baad..d4c5811 100644 --- a/README.mdown +++ b/README.mdown @@ -12,9 +12,19 @@ a static syntax and style checker for Python source code. It supersedes both Installation ------------ -Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using -it already. Make sure you've installed the -[flake8](https://pypi.python.org/pypi/flake8/) package. Then, simply put the + +Make sure you've installed the +[flake8](https://pypi.python.org/pypi/flake8/) package. + +If you use vim >= 8, install this plugin with: +``` +mkdir -p ~/.vim/pack/flake8/start/ +cd ~/.vim/pack/flake8/start/ +git clone https://github.com/nvie/vim-flake8.git +``` + +Otherwise, install [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 `~/.vim/bundle` directory. Usage @@ -41,7 +51,7 @@ the `` key if so. For example, to remap it to `` instead, use: For flake8 configuration options please consult the following page: -https://flake8.readthedocs.org/en/latest/config.html +http://flake8.pycqa.org/en/latest/user/configuration.html To customize the location of your flake8 binary, set `g:flake8_cmd`: @@ -108,6 +118,20 @@ This plugin goes well together with the following plugin: and ``) +Max line lengths +---------------- + +One particular customization a lot of people like to make is relaxing the +maximum line length default. This is a config setting that should be set in +flake8 itself. (vim-flake8 "just" invokes it and deals with showing the output +in Vim's quickfix window.) + +To do so, put the following into your `~/.config/flake8` file: + + [flake8] + max-line-length = 120 + + History ------- 1.6: Deprecated configuring flake8 options through Vim settings. Instead,