[Python-checkins] peps: Add brief explanation and web pointers to README.txt. Fixes issue 19822.
guido.van.rossum
python-checkins at python.org
Fri Nov 29 19:27:00 CET 2013
http://hg.python.org/peps/rev/34cb64cdbf7b
changeset: 5325:34cb64cdbf7b
user: Guido van Rossum <guido at dropbox.com>
date: Fri Nov 29 10:26:55 2013 -0800
summary:
Add brief explanation and web pointers to README.txt. Fixes issue 19822.
files:
README.txt | 17 ++++++++++++++---
1 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/README.txt b/README.txt
--- a/README.txt
+++ b/README.txt
@@ -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
=========================
Original PEP source may be written using two standard formats, a
mildly idiomatic plaintext format and the reStructuredText format
-(also, technically plaintext). These two formats are described in PEP
-9 and PEP 12 respectively. The pep2html.py processing and
+(also, technically plaintext). These two formats are described in
+PEP 9 and PEP 12 respectively. The pep2html.py processing and
installation script knows how to produce the HTML for either PEP
format.
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.
--
Repository URL: http://hg.python.org/peps
More information about the Python-checkins
mailing list