[Python-checkins] devguide: #13228: add a "Quick Start" section to the index page.

[ezio.melotti]

http://hg.python.org/devguide/rev/25f1c003ea01
changeset:   459:25f1c003ea01
user:        Ezio Melotti <ezio.melotti at gmail.com>
date:        Mon Oct 24 02:30:33 2011 +0300
summary:
  #13228: add a "Quick Start" section to the index page.

files:
  index.rst |  25 +++++++++++++++++++++++--
  setup.rst |   6 ++++++
  2 files changed, 29 insertions(+), 2 deletions(-)


diff --git a/index.rst b/index.rst
--- a/index.rst
+++ b/index.rst
@@ -34,13 +34,33 @@
    faq
 
 
+Quick Start
+-----------
+
+Here is a list of the basic step necessary to get set up and make a patch:
+
+1. get :ref:`a clone of CPython <setup>` with
+   ``hg clone http://hg.python.org/cpython``;
+2. On UNIX, run ``./configure --with-pydebug && make -j2`` to
+   :ref:`build Python <compiling>`.
+
+   On :ref:`Windows <windows-compiling>`, load the project file
+   :file:`PCbuild\\pcbuild.sln` in Visual Studio, select :menuselection:`Debug`,
+   and :menuselection:`Build -> Build Solution`;
+3. :doc:`run the tests <runtests>` with ``./python -m test -j3``
+   (use :file:`./python.exe` on :ref:`most <python.exe>` Mac OS X systems and
+   :file:`PCbuild\\python_d.exe` on Windows);
+4. make the :doc:`patch <patch>`;
+5. submit it to the `issue tracker`_.
+
+
 Quick Links
 -----------
 
 Here are some links that you may find you reference frequently while
 contributing to Python.
 
-* `Issue tracker <http://bugs.python.org/>`_
+* `Issue tracker`_
 * `Buildbot status`_
 * :doc:`faq`
 * PEPs_ (Python Enhancement Proposals)
@@ -138,7 +158,7 @@
 * Coding style guides
     * :PEP:`7` (Style Guide for C Code)
     * :PEP:`8` (Style Guide for Python Code)
-* `Issue tracker <http://bugs.python.org/>`_
+* `Issue tracker`_
     * `Meta tracker <http://psf.upfronthosting.co.za/roundup/meta>`_ (issue
       tracker for the issue tracker)
     * :doc:`experts`
@@ -171,6 +191,7 @@
 .. _Jython: http://www.jython.org/
 .. _IronPython: http://ironpython.net/
 .. _Stackless: http://www.stackless.com/
+.. _Issue tracker: http://bugs.python.org/
 
 
 Indices and tables
diff --git a/setup.rst b/setup.rst
--- a/setup.rst
+++ b/setup.rst
@@ -55,6 +55,8 @@
 affected files as described below.)
 
 
+.. _compiling:
+
 Compiling (for debugging)
 -------------------------
 
@@ -122,6 +124,8 @@
 Otherwise the build failed and thus should be fixed (at least with a bug being
 filed on the `issue tracker`_).
 
+.. _python.exe:
+
 Once CPython is done building you will then have a working build
 that can be run in-place; ``./python`` on most machines (and what is used in
 all examples), ``./python.exe`` wherever a case-insensitive filesystem is used
@@ -148,6 +152,8 @@
 still build properly).
 
 
+.. _windows-compiling:
+
 Windows
 '''''''
 

-- 
Repository URL: http://hg.python.org/devguide