summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorent Xicluna <florent.xicluna@gmail.com>2014-04-26 16:39:00 +0200
committerFlorent Xicluna <florent.xicluna@gmail.com>2014-04-26 16:39:00 +0200
commitb8af00d395281045135f4decbafe796b12f3b2e2 (patch)
tree0f756199cd86477bf5d3bcc3d00c69676b058831
parent8c4cd1041b8dc718c72db075a3d1b64b261a094a (diff)
downloadpyflakes-b8af00d395281045135f4decbafe796b12f3b2e2.tar.gz
Hopefully it will avoid some invalid bug reports
-rw-r--r--README.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index adfd83c..476e52a 100644
--- a/README.rst
+++ b/README.rst
@@ -11,8 +11,6 @@ modules with side effects. It's also much faster.
It is `available on PyPI <http://pypi.python.org/pypi/pyflakes>`_
and it supports all active versions of Python from 2.5 to 3.4.
-If you require more options and more flexibility, you could give a
-look to `Flake8 <http://flake8.readthedocs.org/>`_ too.
Installation
@@ -23,6 +21,19 @@ It can be installed with::
$ pip install --upgrade pyflakes
+Useful tips:
+
+* Be sure to install it for a version of Python which is compatible
+ with your codebase: for Python 2, ``pip2 install pyflakes`` and for
+ Python3, ``pip3 install pyflakes``.
+
+* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
+ ``python2 -m pyflakes .`` if you have it installed for both versions.
+
+* If you require more options and more flexibility, you could give a
+ look to `Flake8 <http://flake8.readthedocs.org/>`_ too.
+
+
Mailing-list
------------