Skip to content

Commit b7f7dd5

Browse files
committed
Enhance README formatting and content clarity
Updated formatting and added emphasis to copyright and license information. Improved clarity in several sections.
1 parent 9ad6ba0 commit b7f7dd5

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

README.rst

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
1+
.. image:: https://www.python.org/static/community_logos/python-logo-master-v3-TM.png
2+
:align: center
3+
:alt: Python Logo
4+
:width: 400px
5+
16
This is Python version 3.16.0 alpha 0
27
=====================================
38

49
.. image:: https://github.com/python/cpython/actions/workflows/build.yml/badge.svg?branch=main&event=push
510
:alt: CPython build status on GitHub Actions
611
:target: https://github.com/python/cpython/actions
7-
812
.. image:: https://dev.azure.com/python/cpython/_apis/build/status/Azure%20Pipelines%20CI?branchName=main
913
:alt: CPython build status on Azure DevOps
1014
:target: https://dev.azure.com/python/cpython/_build/latest?definitionId=4&branchName=main
11-
1215
.. image:: https://img.shields.io/badge/discourse-join_chat-brightgreen.svg
1316
:alt: Python Discourse chat
1417
:target: https://discuss.python.org/
1518

1619

17-
Copyright © 2001 Python Software Foundation. All rights reserved.
20+
**Copyright © 2001 Python Software Foundation. All rights reserved.**
1821

19-
See the end of this file for further copyright and license information.
22+
*See the end of this file for further copyright and license information.*
2023

21-
.. contents::
24+
.. contents:: **Table of Contents**
25+
:local:
26+
:depth: 2
27+
28+
----
2229

2330
General Information
2431
-------------------
@@ -45,10 +52,14 @@ Installable Python kits, and information about using Python, are available at
4552

4653
.. _python.org: https://www.python.org/
4754

55+
----
56+
4857
Build Instructions
4958
------------------
5059

51-
On Unix, Linux, BSD, macOS, and Cygwin::
60+
On Unix, Linux, BSD, macOS, and Cygwin:
61+
62+
.. code-block:: shell
5263
5364
./configure
5465
make
@@ -80,7 +91,9 @@ To build Windows installer, see `Tools/msi/README.txt
8091
<https://github.com/python/cpython/blob/main/Tools/msi/README.txt>`_.
8192

8293
If you wish, you can create a subdirectory and invoke configure from there.
83-
For example::
94+
For example:
95+
96+
.. code-block:: shell
8497
8598
mkdir debug
8699
cd debug
@@ -122,7 +135,6 @@ The final step is to build the actual interpreter, using the information
122135
collected from the instrumented one. The end result will be a Python binary
123136
that is optimized; suitable for distribution or production installation.
124137

125-
126138
Link Time Optimization
127139
^^^^^^^^^^^^^^^^^^^^^^
128140

@@ -131,6 +143,7 @@ ability of recent compiler toolchains to optimize across the otherwise
131143
arbitrary ``.o`` file boundary when building final executables or shared
132144
libraries for additional performance gains.
133145

146+
----
134147

135148
What's New
136149
----------
@@ -145,7 +158,6 @@ accounting of changes can only be gleaned from the `commit history
145158
If you want to install multiple versions of Python, see the section below
146159
entitled "Installing multiple versions".
147160

148-
149161
Documentation
150162
-------------
151163

@@ -160,6 +172,7 @@ formatting requirements.
160172
For information about building Python's documentation, refer to `Doc/README.rst
161173
<https://github.com/python/cpython/blob/main/Doc/README.rst>`_.
162174

175+
----
163176

164177
Testing
165178
-------
@@ -174,7 +187,9 @@ By default, tests are prevented from overusing resources like disk space and
174187
memory. To enable these tests, run ``make buildbottest``.
175188

176189
If any tests fail, you can re-run the failing test(s) in verbose mode. For
177-
example, if ``test_os`` and ``test_gdb`` failed, you can run::
190+
example, if ``test_os`` and ``test_gdb`` failed, you can run:
191+
192+
.. code-block:: shell
178193
179194
make test TESTOPTS="-v test_os test_gdb"
180195
@@ -204,17 +219,16 @@ For example, if you want to install Python 2.7, 3.6, and 3.15 with 3.15 being th
204219
primary version, you would execute ``make install`` in your 3.15 build directory
205220
and ``make altinstall`` in the others.
206221

207-
208222
Release Schedule
209223
----------------
210224

211225
See `PEP 826 <https://peps.python.org/pep-0826/>`__ for Python 3.16 release details.
212226

227+
----
213228

214229
Copyright and License Information
215230
---------------------------------
216231

217-
218232
Copyright © 2001 Python Software Foundation. All rights reserved.
219233

220234
Copyright © 2000 BeOpen.com. All rights reserved.

0 commit comments

Comments
 (0)