diff --git a/README b/README.rst rename from README rename to README.rst --- a/README +++ b/README.rst @@ -1,3 +1,4 @@ +==================================== This is Python version 3.6.0 alpha 3 ==================================== @@ -12,30 +13,30 @@ Build Instructions ------------------- +================== -On Unix, Linux, BSD, OSX, and Cygwin: +On Unix, Linux, BSD, OSX, and Cygwin:: ./configure make make test sudo make install -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; 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 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. +On Windows, see ``PCbuild/readme.txt``. If you wish, you can create a subdirectory and invoke configure from there. -For example: +For example:: mkdir debug cd debug @@ -43,16 +44,16 @@ 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.) +(This will fail if you **also** built at the top-level directory. +You should do a ``make clean`` at the toplevel first.) -If you need an optimized version of Python, you type "make profile-opt" in the -top level directory. This will rebuild the interpreter executable using Profile -Guided Optimization (PGO). For more details, see the section bellow. +If you need an optimized version of Python, you type ``make profile-opt`` in +the top level directory. This will rebuild the interpreter executable using +Profile Guided Optimization (PGO). For more details, see the section bellow. Profile Guided Optimization ---------------------------- +=========================== PGO takes advantage of recent versions of the GCC or Clang compilers. If ran, the "profile-opt" rule will do several steps. @@ -76,7 +77,7 @@ What's New ----------- +========== We have a comprehensive overview of the changes in the "What's New in Python 3.6" document, found at @@ -92,7 +93,7 @@ Documentation -------------- +============= Documentation for Python 3.6 is online, updated daily: @@ -112,7 +113,7 @@ Converting From Python 2.x to 3.x ---------------------------------- +================================= 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 @@ -125,20 +126,20 @@ 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 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 is produced, something is wrong. 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* -include the output of "make test". It is useless. Run the failing test -manually, as follows: +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 +manually, as follows:: ./python -m test -v test_whatever @@ -147,26 +148,26 @@ Installing multiple versions ----------------------------- +============================ 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) -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 -"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 -${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. -Install that version using "make install". Install all other versions using -"make altinstall". +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 installation of a different version. All files and +directories installed using ``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 ``${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. Install that version using ``make +install``. Install all other versions using ``make altinstall``. For example, if you want to install Python 2.6, 2.7 and 3.6 with 2.7 being the -primary version, you would execute "make install" in your 2.7 build directory -and "make altinstall" in the others. +primary version, you would execute ``make install`` in your 2.7 build directory +and ``make altinstall`` in the others. Issue Tracker and Mailing List ------------------------------- +============================== 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: @@ -184,7 +185,7 @@ 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 initial feedback. A Python @@ -194,13 +195,13 @@ Release Schedule ----------------- +================ See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/ Copyright and License Information ---------------------------------- +================================= Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Python Software Foundation. All rights reserved. @@ -215,7 +216,7 @@ See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES. -This Python distribution contains *no* GNU General Public License (GPL) code, +This Python distribution contains **no** GNU General Public License (GPL) code, so it may be used in proprietary projects. There are interfaces to some GNU code but these are entirely optional.