Rename README to README.rst and enhance formatting (#2)

Update also the Release Schedule to Python 3.7.
This commit is contained in:
Victor Stinner 2017-02-11 02:21:38 +01:00 committed by GitHub
parent 4538ddcacc
commit d783b01fdf
2 changed files with 44 additions and 51 deletions

View File

@ -197,7 +197,7 @@ SUBDIRSTOO= Include Lib Misc
# Files and directories to be distributed # Files and directories to be distributed
CONFIGFILES= configure configure.ac acconfig.h pyconfig.h.in Makefile.pre.in CONFIGFILES= configure configure.ac acconfig.h pyconfig.h.in Makefile.pre.in
DISTFILES= README ChangeLog $(CONFIGFILES) DISTFILES= README.rst ChangeLog $(CONFIGFILES)
DISTDIRS= $(SUBDIRS) $(SUBDIRSTOO) Ext-dummy DISTDIRS= $(SUBDIRS) $(SUBDIRSTOO) Ext-dummy
DIST= $(DISTFILES) $(DISTDIRS) DIST= $(DISTFILES) $(DISTDIRS)

View File

@ -15,7 +15,7 @@ been removed.
Build Instructions Build Instructions
------------------ ------------------
On Unix, Linux, BSD, OSX, and Cygwin: On Unix, Linux, BSD, OSX, and Cygwin::
./configure ./configure
make make
@ -24,19 +24,19 @@ On Unix, Linux, BSD, OSX, and Cygwin:
This will install Python as python3. This will install Python as python3.
You can pass many options to the configure script; run "./configure --help" to 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; find out more. On OSX and Cygwin, the executable is called ``python.exe``;
elsewhere it's just python. elsewhere it's just ``python``.
On Mac OS X, if you have configured Python with --enable-framework, you should 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 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 Python executable in a place that is not normally on your PATH, you may want to
set up a symlink in /usr/local/bin. set up a symlink in ``/usr/local/bin``.
On Windows, see PCbuild/readme.txt. On Windows, see PCbuild/readme.txt.
If you wish, you can create a subdirectory and invoke configure from there. If you wish, you can create a subdirectory and invoke configure from there.
For example: For example::
mkdir debug mkdir debug
cd debug cd debug
@ -45,10 +45,10 @@ For example:
make test make test
(This will fail if you *also* built at the top-level directory. (This will fail if you *also* built at the top-level directory.
You should do a "make clean" at the toplevel first.) You should do a ``make clean`` at the toplevel first.)
To get an optimized build of Python, "configure --enable-optimizations" before To get an optimized build of Python, ``configure --enable-optimizations`` before
you run make. This sets the default make targets up to enable Profile Guided you run ``make``. This sets the default make targets up to enable Profile Guided
Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO) Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO)
on some platforms. For more details, see the sections bellow. on some platforms. For more details, see the sections bellow.
@ -57,7 +57,7 @@ Profile Guided Optimization
--------------------------- ---------------------------
PGO takes advantage of recent versions of the GCC or Clang compilers. PGO takes advantage of recent versions of the GCC or Clang compilers.
If ran, "make profile-opt" will do several steps. If ran, ``make profile-opt`` will do several steps.
First, the entire Python directory is cleaned of temporary files that First, the entire Python directory is cleaned of temporary files that
may have resulted in a previous compilation. may have resulted in a previous compilation.
@ -80,8 +80,8 @@ that is optimized and suitable for distribution or production installation.
Link Time Optimization Link Time Optimization
---------------------- ----------------------
Enabled via configure's --with-lto flag. LTO takes advantages of recent Enabled via configure's ``--with-lto`` flag. LTO takes advantages of recent
compiler toolchains ability to optimize across the otherwise arbitrary .o file compiler toolchains ability to optimize across the otherwise arbitrary ``.o`` file
boundary when building final executables or shared libraries for additional boundary when building final executables or shared libraries for additional
performance gains. performance gains.
@ -89,10 +89,8 @@ performance gains.
What's New What's New
---------- ----------
We have a comprehensive overview of the changes in the "What's New in We have a comprehensive overview of the changes in the `What's New in
Python 3.7" document, found at Python 3.7 <https://docs.python.org/3.7/whatsnew/3.7.html>`_ document.
https://docs.python.org/3.7/whatsnew/3.7.html
For a more detailed change log, read Misc/NEWS (though this file, too, 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 is incomplete, and also doesn't list anything merged in from the 2.7
@ -105,9 +103,8 @@ entitled "Installing multiple versions".
Documentation Documentation
------------- -------------
Documentation for Python 3.7 is online, updated daily: `Documentation for Python 3.7 <https://docs.python.org/3.7/>`_ is online,
updated daily.
https://docs.python.org/3.7/
It can also be downloaded in many formats for faster access. The documentation It can also be downloaded in many formats for faster access. The documentation
is downloadable in HTML, PDF, and reStructuredText formats; the latter version is downloadable in HTML, PDF, and reStructuredText formats; the latter version
@ -115,9 +112,8 @@ is primarily for documentation authors, translators, and people with special
formatting requirements. formatting requirements.
If you would like to contribute to the development of Python, relevant If you would like to contribute to the development of Python, relevant
documentation is available at: documentation is available at: `Python Developer's Guide
<https://docs.python.org/devguide/>`_.
https://docs.python.org/devguide/
For information about building Python's documentation, refer to Doc/README.txt. For information about building Python's documentation, refer to Doc/README.txt.
@ -129,27 +125,28 @@ Python starting with 2.6 contains features to help locating code that needs to
be changed, such as optional warnings when deprecated features are used, and be changed, such as optional warnings when deprecated features are used, and
backported versions of certain key Python 3.x features. backported versions of certain key Python 3.x features.
A source-to-source translation tool, "2to3", can take care of the mundane task 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 of converting large amounts of source code. It is not a complete solution but
is complemented by the deprecation warnings in 2.6. See is complemented by the deprecation warnings in 2.6. See
https://docs.python.org/3.7/library/2to3.html for more information. `2to3 documentation <https://docs.python.org/3.7/library/2to3.html>`_ for more
information.
Testing Testing
------- -------
To test the interpreter, type "make test" in the top-level directory. To test the interpreter, type ``make test`` in the top-level directory.
The test set produces some output. You can generally ignore the messages The test set produces some output. You can generally ignore the messages
about skipped tests due to optional features which can't be imported. about skipped tests due to optional features which can't be imported.
If a message is printed about a failed test or a traceback or core dump If a message is printed about a failed test or a traceback or core dump
is produced, something is wrong. is produced, something is wrong.
By default, tests are prevented from overusing resources like disk space and By default, tests are prevented from overusing resources like disk space and
memory. To enable these tests, run "make testall". memory. To enable these tests, run ``make testall``.
IMPORTANT: If the tests fail and you decide to mail a bug report, *don't* IMPORTANT: If the tests fail and you decide to mail a bug report, *don't*
include the output of "make test". It is useless. Run the failing test include the output of ``make test``. It is useless. Run the failing test
manually, as follows: manually, as follows::
./python -m test -v test_whatever ./python -m test -v test_whatever
@ -161,19 +158,19 @@ Installing multiple versions
---------------------------- ----------------------------
On Unix and Mac systems if you intend to install multiple versions of Python On Unix and Mac systems if you intend to install multiple versions of Python
using the same installation prefix (--prefix argument to the configure script) using the same installation prefix (``--prefix`` argument to the configure script)
you must take care that your primary python executable is not overwritten by the you must take care that your primary python executable is not overwritten by the
installation of a different version. All files and directories installed using installation of a different version. All files and directories installed using
"make altinstall" contain the major and minor version and can thus live ``make altinstall`` contain the major and minor version and can thus live
side-by-side. "make install" also creates ${prefix}/bin/python3 which refers to side-by-side. ``make install`` also creates ``${prefix}/bin/python3`` which refers to
${prefix}/bin/pythonX.Y. If you intend to install multiple versions using the ``${prefix}/bin/pythonX.Y``. If you intend to install multiple versions using the
same prefix you must decide which version (if any) is your "primary" version. same prefix you must decide which version (if any) is your "primary" version.
Install that version using "make install". Install all other versions using Install that version using ``make install``. Install all other versions using
"make altinstall". ``make altinstall``.
For example, if you want to install Python 2.7, 3.6, and 3.7 with 3.7 being the For example, if you want to install Python 2.7, 3.6, and 3.7 with 3.7 being the
primary version, you would execute "make install" in your 3.7 build directory primary version, you would execute ``make install`` in your 3.7 build directory
and "make altinstall" in the others. and ``make altinstall`` in the others.
Issue Tracker and Mailing List Issue Tracker and Mailing List
@ -181,33 +178,29 @@ Issue Tracker and Mailing List
We're soliciting bug reports about all aspects of the language. Fixes are also We're soliciting bug reports about all aspects of the language. Fixes are also
welcome, preferably in unified diff format. Please use the issue tracker: welcome, preferably in unified diff format. Please use the issue tracker:
`bugs.python.org <https://bugs.python.org/>`_.
https://bugs.python.org/
If you're not sure whether you're dealing with a bug or a feature, use the If you're not sure whether you're dealing with a bug or a feature, use the
mailing list: mailing list: python-dev@python.org. To subscribe to the list, use the mailman
form: `python-dev <https://mail.python.org/mailman/listinfo/python-dev/>`_
python-dev@python.org
To subscribe to the list, use the mailman form:
https://mail.python.org/mailman/listinfo/python-dev/
Proposals for enhancement Proposals for enhancement
------------------------- -------------------------
If you have a proposal to change Python, you may want to send an email to the 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 initial feedback. A Python comp.lang.python or
`python-ideas <https://mail.python.org/mailman/listinfo/python-ideas/>`_
mailing lists for initial feedback. A Python
Enhancement Proposal (PEP) may be submitted if your idea gains ground. All 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 current PEPs, as well as guidelines for submitting a new PEP, are listed at
https://www.python.org/dev/peps/. `python.org/dev/peps/ <https://www.python.org/dev/peps/>`_.
Release Schedule Release Schedule
---------------- ----------------
See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/ See :pep:`537` for Python 3.7 release details.
Copyright and License Information Copyright and License Information