Mercurial > cpython-lru_cache-weakref

changeset 54865:a69a031ac140 v3.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rearrange the sections of the README, so they'll hopefully be more in the order people will interested in
author Benjamin Peterson <benjamin@python.org>
date Fri, 26 Jun 2009 13:21:52 +0000
parents 12e960cc37d6
children 7c9e1c9ec5df
files README
diffstat 1 files changed, 65 insertions(+), 71 deletions(-) [+]
line wrap: on
line diff
--- a/README	Fri Jun 26 13:11:28 2009 +0000
+++ b/README	Fri Jun 26 13:21:52 2009 +0000
@@ -12,10 +12,57 @@
 removed.
 
 
-Release Schedule
-----------------
+Build Instructions
+------------------
+
+On Unix, Linux, BSD, OSX, and Cygwin:
+
+    ./configure
+    make
+    make test
+    sudo make install
+
+This will install Python as python3.
+
+You can pass many options to the configure script; run "./configure
+--help" to find out more.  On OSX and Cygwin, the executable is called
+python.exe; elsewhere it's just python.
+
+On Mac OS X, if you have configured Python with --enable-framework,
+you should use "make frameworkinstall" to do the installation.  Note
+that this installs the Python executable in a place that is not
+normally on your PATH, you may want to set up a symlink in
+/usr/local/bin.
+
+On Windows, see PCbuild/readme.txt.
 
-See PEP 375 for release details: http://www.python.org/dev/peps/pep-0375/
+If you wish, you can create a subdirectory and invoke configure from
+there.  For example:
+
+    mkdir debug
+    cd debug
+    ../configure --with-pydebug
+    make
+    make test
+
+(This will fail if you *also* built at the top-level directory.  You
+should do a "make clean" at the toplevel first.)
+
+
+What's New
+----------
+
+We try to have a comprehensive overview of the changes in the "What's New in
+Python 3.1" document, found at
+
+    http://docs.python.org/dev/3.1/whatsnew/3.1.html
+
+For a more detailed change log, read Misc/NEWS (though this file, too,
+is incomplete, and also doesn't list anything merged in from the 2.7
+release under development).
+
+If you want to install multiple versions of Python see the section below
+entitled "Installing multiple versions".
 
 
 Documentation
@@ -34,34 +81,6 @@
 translators, and people with special formatting requirements.
 
 
-What's New
-----------
-
-We try to have a comprehensive overview of the changes in the "What's New in
-Python 3.1" document, found at
-
-    http://docs.python.org/dev/3.1/whatsnew/3.1.html
-
-Please help write it!
-
-For a more detailed change log, read Misc/NEWS (though this file, too,
-is incomplete, and also doesn't list anything merged in from the 2.7
-release under development).
-
-If you want to install multiple versions of Python see the section below
-entitled "Installing multiple versions".
-
-
-Proposals for enhancement
--------------------------
-
-If you have a proposal to change Python, you may want to send an email to the
-comp.lang.python or python-ideas mailing lists for inital feedback. A Python
-Enhancement Proposal (PEP) may be submitted if your idea gains ground. All
-current PEPs, as well as guidelines for submitting a new PEP, are listed at
-http://www.python.org/dev/peps/.
-
-
 Converting From Python 2.x to 3.x
 ---------------------------------
 
@@ -69,6 +88,11 @@
 needs to be changed, such as optional warnings when deprecated features are
 used, and backported versions of certain key Python 3.x features.
 
+A source-to-source translation tool, "2to3", can take care of the mundane task
+of converting large amounts of source code.  It is not a complete solution but
+is complemented by the deprecation warnings in 2.6.  See
+http://docs.python.org/dev/py3k/library/2to3.html for more information.
+
 
 Testing
 -------
@@ -116,17 +140,6 @@
 directory and "make altinstall" in the others.
 
 
-Configuration options and variables
------------------------------------
-
-A source-to-source translation tool, "2to3", can take care of the
-mundane task of converting large amounts of source code.  It is not a
-complete solution but is complemented by the deprecation warnings in
-2.6.  This tool is currently available via the Subversion sandbox:
-
-    http://svn.python.org/view/sandbox/trunk/2to3/
-
-
 Issue Tracker and Mailing List
 ------------------------------
 
@@ -146,39 +159,20 @@
     http://mail.python.org/mailman/listinfo/python-dev/
 
 
-Build Instructions
-------------------
-
-On Unix, Linux, BSD, OSX, and Cygwin:
-
-    ./configure
-    make
-    make test
-    sudo make install
-
-You can pass many options to the configure script; run "./configure
---help" to find out more.  On OSX and Cygwin, the executable is called
-python.exe; elsewhere it's just python.
+Proposals for enhancement
+-------------------------
 
-On Mac OS X, if you have configured Python with --enable-framework,
-you should use "make frameworkinstall" to do the installation.  Note
-that this installs the Python executable in a place that is not
-normally on your PATH, you may want to set up a symlink in
-/usr/local/bin.
-
-On Windows, see PCbuild/readme.txt.
+If you have a proposal to change Python, you may want to send an email to the
+comp.lang.python or python-ideas mailing lists for inital feedback. A Python
+Enhancement Proposal (PEP) may be submitted if your idea gains ground. All
+current PEPs, as well as guidelines for submitting a new PEP, are listed at
+http://www.python.org/dev/peps/.
 
-If you wish, you can create a subdirectory and invoke configure from
-there.  For example:
 
-    mkdir debug
-    cd debug
-    ../configure --with-pydebug
-    make
-    make test
+Release Schedule
+----------------
 
-(This will fail if you *also* built at the top-level directory.  You
-should do a "make clean" at the toplevel first.)
+See PEP 375 for release details: http://www.python.org/dev/peps/pep-0375/
 
 
 Copyright and License Information