diff --git a/index.rst b/index.rst --- a/index.rst +++ b/index.rst @@ -34,6 +34,26 @@ 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 the project file + :file:`PCbuild\\pcbuild.sln` in Visual Studio, select :menuselection:`Debug`, + and :menuselection:`Build -> Build Solution`; +3. :doc:`run the tests ` with ``./python -m test -j3`` + (use :file:`./python.exe` on :ref:`most ` Mac OS X and + :file:`PCbuild\\python_d.exe` on 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) ------------------------- @@ -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 '''''''