diff --git a/index.rst b/index.rst --- a/index.rst +++ b/index.rst @@ -34,6 +34,25 @@ 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 ` with + ``hg clone http://hg.python.org/cpython``; +2. On UNIX, run ``./configure --with-pydebug && make -j2`` to + :ref:`build Python `. + + On :ref:`Windows `, load in Visual Studio the project + files from the ``PCbuild`` directory, select :menuselection:`Debug` and + :menuselection:`Build -> Build Solution`; +3. :doc:`run the tests ` with ``./python -m test -j2`` + (``python.exe`` on Mac OS X and Windows); +4. make the :doc:`patch `; +5. submit it to the `issue tracker `_. + + Quick Links ----------- 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) ------------------------- @@ -148,6 +150,8 @@ still build properly). +.. _windows-compiling: + Windows '''''''