]> 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
Reread configuration upon every invocation of Flake8().
[etc/vim.git] / README.mdown
diff --git a/README.mdown b/README.mdown
index 99ef175da759223f5c3c0eb06d68dda1261ba106..86a09cb2b967a65e4bb66b0fec59ce31dc2ad688 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,22 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 
+To ignore errors, in your .vimrc:
+
+    let g:flake8_ignore="E501,W293"
+
+If you want to change the max line length for PEP8:
+
+    let g:flake8_max_line_length=99
+
+To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued:
+
+    let g:flake8_max_complexity=10
+
+To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
+
+    let g:flake8_cmd="/opt/strangebin/flake8000"
+
 
 Tips
 ----
@@ -41,14 +59,6 @@ enable this, add the following line to your `.vimrc` file (thanks
 
     autocmd BufWritePost *.py call Flake8()
 
-To ignore errors, in your .vimrc:
-
-    let g:flake8_ignore="E501,W293"
-
-If you want to cutomize the location of your flake8 binary, set `g:flake8_cmd`:
-
-    let g:flake8_cmd="/opt/strangebin/flake8000"
-
 This plugin goes well together with the following plugin:
 
 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
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.