Add brief explanation and web pointers to README.txt. Fixes issue 19822.

This commit is contained in:
Guido van Rossum 2013-11-29 10:26:55 -08:00
parent d6a9523ada
commit 4e1159972e
1 changed files with 14 additions and 3 deletions

View File

@ -1,12 +1,23 @@
Python Enhancement Proposals
============================
The PEPs in this repo are published automatically on the web at
http://www.python.org/dev/peps/. To learn more about the purpose of
PEPs and how to go about writing a PEP, please start reading at PEP 1
(pep-0001.txt in this repo). Note that PEP 0, the index PEP, is now
automatically generated, and not committed to the repo.
reStructuredText for PEPs reStructuredText for PEPs
========================= =========================
Original PEP source may be written using two standard formats, a Original PEP source may be written using two standard formats, a
mildly idiomatic plaintext format and the reStructuredText format mildly idiomatic plaintext format and the reStructuredText format
(also, technically plaintext). These two formats are described in PEP (also, technically plaintext). These two formats are described in
9 and PEP 12 respectively. The pep2html.py processing and PEP 9 and PEP 12 respectively. The pep2html.py processing and
installation script knows how to produce the HTML for either PEP installation script knows how to produce the HTML for either PEP
format. format.
For processing reStructuredText format PEPs, you need the docutils For processing reStructuredText format PEPs, you need the docutils
package, which is available from PyPI. package, which is available from PyPI (http://pypi.python.org).
If you have pip, "pip install docutils" should install it.