summaryrefslogtreecommitdiff
path: root/docs/source/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/user')
-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