Merge pull request #77 from DanielJSottile/fix_hints

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index e1872e50e3fbb03252e5480d512a782705c4b37a..5d4e00c8a4af97bfa45b805f52f06cfb3cb9f98f 100644 (file)
--- 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
@@ -37,11 +47,11 @@ If you don't want to use the `<F7>` key for flake8-checking, simply remap it to
 another key.  It autodetects whether it has been remapped and won't register
 the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
-    autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
+    autocmd FileType python map <buffer> <F3> :call flake8#Flake8()<CR>
 
 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`:
 
@@ -51,6 +61,10 @@ To customize the location of quick fix window, set `g:flake8_quickfix_location`:
 
     let g:flake8_quickfix_location="topleft"
 
+To customize the height of quick fix window, set `g:flake8_quickfix_height`:
+
+    let g:flake8_quickfix_height=7
+
 To customize whether the quickfix window opens, set `g:flake8_show_quickfix`:
 
     let g:flake8_show_quickfix=0  " don't show
@@ -96,7 +110,7 @@ A tip might be to run the Flake8 check every time you write a Python file, to
 enable this, add the following line to your `.vimrc` file (thanks
 [Godefroid](https://github.com/gotcha)!):
 
-    autocmd BufWritePost *.py call Flake8()
+    autocmd BufWritePost *.py call flake8#Flake8()
 
 This plugin goes well together with the following plugin:
 
@@ -104,10 +118,33 @@ This plugin goes well together with the following plugin:
   and `<F9>`)
 
 
+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,
-advise users to use the flake8 config file.
+advise users to use the `~/.config/flake8` config file.
+
+    - Decprecated options:
+      - `g:flake8_builtins`
+      - `g:flake8_ignore`
+      - `g:flake8_max_line_length`
+      - `g:flake8_max_complexity`
+
+    - New options:
+      - `g:flake8_quickfix_height`
 
 1.5: Added markers and the option to don't show the quickfix window, also split
 functions into a autoload file. Added: