[Python-checkins] distutils2: Update and expand README
eric.araujo
python-checkins at python.org
Mon Nov 14 15:24:07 CET 2011
http://hg.python.org/distutils2/rev/9602fadd902a
changeset: 1222:9602fadd902a
user: Éric Araujo <merwok at netwok.org>
date: Fri Nov 11 10:38:59 2011 +0100
summary:
Update and expand README
files:
README.txt | 53 ++++++++++++++++++++++++++++-------------
1 files changed, 36 insertions(+), 17 deletions(-)
diff --git a/README.txt b/README.txt
--- a/README.txt
+++ b/README.txt
@@ -1,24 +1,43 @@
-==========
-Distutils2
-==========
+=======================
+ Welcome to Distutils2
+=======================
-Welcome to Distutils2!
+Distutils2 is the packaging library that supersedes Distutils. It has three
+main audiences:
-Distutils2 is the new version of Distutils. It's not backward compatible with
-Distutils but provides more features, and implement most new packaging
-standards.
+- Python authors who want to distribute their code
+- End users who want to install modules or applications
+- Developers of packaging-related tools who need a support library to
+ build on
-See the documentation at http://packages.python.org/Distutils2 for more info.
+Authors will have to write a :file:`setup.cfg` file and run a few
+commands to package and distribute their code. End users will be able to
+search for, install and remove Python projects with the included
+``pysetup`` program. Last, developers will be able to reuse classes and
+functions in their tools.
-If you want to contribute, please have a look to
-http://distutils2.notmyidea.org/contributing.html
+The Distutils2 codebase is a fork of Distutils. It is not backward compatible
+with Distutils and does not depend on it. It provides more features and
+implements new packaging standards. In Python 3.3, Distutils2 is included in
+the standard library under the module name "packaging". Documentation is
+provided at http://docs.python.org/dev/packaging --for ease of maintenance, it
+is not duplicated in this repository. You can use the Packaging documentation
+to use Distutils2; only the package name is different (packaging vs.
+distutils2), all modules, classes and functions have the same name.
-**Beware that Distutils2 is in its early stage and should not be used in
-production. Its API is subject to changes**
+If you want to contribute, please have a look at DEVNOTES.txt or
+http://wiki.python.org/Distutils2/Contributing .
-Useful further links:
+Beware that Distutils2 is still in alpha stage and its API is subject to
+change. It should be not used for critical deployments. That said, it
+is possible to start using it while keeping compatiblity with tools based
+on the old Distutils or Setuptools, and the developers are eager to get
+feedback from authors, end users and developers.
-Mailing list: http://mail.python.org/mailman/listinfo/distutils-sig/
-Documentation: http://packages.python.org/Distutils2
-Repository: http://hg.python.org/distutils2
-Bug tracker: http://bugs.python.org
+Useful links:
+
+- Mailing list: http://mail.python.org/mailman/listinfo/distutils-sig/
+- Mailing list with friendly tutors to guide new contributors:
+ http://mail.python.org/mailman/listinfo/core-mentorship
+- Repository: http://hg.python.org/distutils2
+- Bug tracker: http://bugs.python.org/ (component "Distutils2")
--
Repository URL: http://hg.python.org/distutils2
More information about the Python-checkins
mailing list