summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>2013-04-29 15:31:03 +0200
committerNicolas Chauvat <nicolas.chauvat@logilab.fr>2013-04-29 15:31:03 +0200
commiteaf43c6b172f26b4e5b5fb0d65ec070b0abe71c8 (patch)
tree0288bbb8c8d51a2f92de0b4df73fe6ed8750db17 /README
parente0d31c2ec17a9968ced556e7e12b37468db1c190 (diff)
downloadpylint-eaf43c6b172f26b4e5b5fb0d65ec070b0abe71c8.tar.gz
[doc] continue refactoring
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 8 insertions, 11 deletions
diff --git a/README b/README
index 89ce088..582d586 100644
--- a/README
+++ b/README
@@ -1,23 +1,22 @@
-README for Pylint (http://www.pylint.org)
-=========================================
+README for Pylint - http://www.pylint.org/
+==========================================
Pylint is a Python source code analyzer which looks for programming errors,
helps enforcing a coding standard and sniffs for some code smells (as defined in
Martin Fowler's Refactoring book).
-Pylint has many rules enabled by default, way too much to silent them all on a
+Pylint has many rules enabled by default, way too much to silence them all on a
minimally sized program. It's highly configurable and handle pragmas to control
it from within your code. Additionally, it is possible to write plugins to add
your own checks.
It's a free software distributed under the GNU Public Licence.
-Development is hosted on bitbucket: https://bitbucket.org/logilab/pylint/ .
-
-You can use the python-projects@logilab.org mailing list to discuss about
-Pylint. Subscribe at http://lists.logilab.org/mailman/listinfo/python-projects
-or read the archives at http://lists.logilab.org/pipermail/python-projects/
+Development is hosted on bitbucket: https://bitbucket.org/logilab/pylint/
+You can use the code-quality@python.org mailing list to discuss about
+Pylint. Subscribe at http://lists.python.org/mailman/listinfo/code-quality
+or read the archives at http://lists.python.org/pipermail/code-quality/
Install
-------
@@ -25,7 +24,7 @@ Install
Pylint requires the astng (the later the better) and logilab-common (version >=
0.53) packages.
-* https://bitbucket.org/logilab/astng
+* https://bitbucket.org/logilab/astng
* http://www.logilab.org/projects/common
From the source distribution, extract the tarball and run ::
@@ -38,7 +37,6 @@ rpm packages, use your usual tools according to your Linux distribution.
More information about installation and available distribution format
may be found in the user manual in the *doc* subdirectory.
-
Documentation
-------------
@@ -51,7 +49,6 @@ Pylint is shipped with following additional commands:
* epylint: Emacs and Flymake compatible Pylint
* pylint-gui: a graphical interface
-
Contributors
------------