summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-05-18 23:05:09 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-05-18 23:05:09 -0500
commitf353a5db907a97b6513c00500f9c593bc35cc76e (patch)
tree0f0a31312baa15f89b3c5744ebae3d98efe09e0e /docs
parent28a97a84999fd4a7bcced54193ab25edd1d1d889 (diff)
downloadflake8-f353a5db907a97b6513c00500f9c593bc35cc76e.tar.gz
Add a tiny bit to Usage Guide index
Diffstat (limited to 'docs')
-rw-r--r--docs/source/user/index.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
index 81732a4..8368509 100644
--- a/docs/source/user/index.rst
+++ b/docs/source/user/index.rst
@@ -2,3 +2,17 @@
Using Flake8
==============
+Flake8 can be used in many ways:
+
+- invoking it on the command-line
+
+- invoking it via Python
+
+- having it called by Git or Mercurial on or around committing
+
+This guide will cover all of these and the nuances for using Flake8.
+
+.. config files
+.. command-line tutorial
+.. VCS usage
+.. installing and using plugins