]> git.madduck.net Git - etc/vim.git/blobdiff - README.mdown

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge pull request #26 from mmedvede/add-quickfix-location
[etc/vim.git] / README.mdown
diff --git a/README.mdown b/README.mdown
index e32260d77449e46c31405ce5d26d83d88405e9f4..4db8b3b333d4859767035acc989eb8ad1b874fae 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -5,14 +5,16 @@ 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).
+[Flake8](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes 
+(static syntax checker), PEP8 (style checker) 
+and Ned's MacCabe script (complexity checker).
 
 
 Installation
 ------------
 Use [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
+it already.  Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package.
+Then, simply put the contents of this repository in your
 `~/.vim/bundle` directory.
 
 Usage
@@ -32,6 +34,10 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 
+To add builtins, in your .vimrc:
+
+    let g:flake8_builtins="_,apply"
+
 To ignore errors, in your .vimrc:
 
     let g:flake8_ignore="E501,W293"
@@ -44,10 +50,13 @@ To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_
 
     let g:flake8_max_complexity=10
 
-To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
+To customize the location of your flake8 binary, set `g:flake8_cmd`:
 
     let g:flake8_cmd="/opt/strangebin/flake8000"
 
+To customize the location of quick fix window, set `g:flake8_quickfix_location`:
+
+    let g:flake8_quickfix_location="topleft"
 
 Tips
 ----
@@ -61,3 +70,22 @@ This plugin goes well together with the following plugin:
 
 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
   and `<F9>`)
+
+
+History
+-------
+
+1.3: Added the following options:
+
+     - `g:flake8_builtins="_,apply"`
+     - `g:flake8_max_complexity=10`
+
+1.2: Added the following options:
+
+     - `g:flake8_cmd="/opt/strangebin/flake8000"`
+     - `g:flake8_max_line_length=120`
+     - `g:flake8_ignore="E501,W293"`
+
+1.1: Added `g:flake8_ignore` option.
+
+1.0: Initial version.
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.