Skip to content

Commit

Permalink
Made "install dependencies" as Step number one. (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mariatta authored and ncoghlan committed Sep 21, 2016
1 parent 9adca02 commit 93a3531
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 11 deletions.
39 changes: 28 additions & 11 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,36 +14,53 @@ Quick Start
Here are the basic steps needed to get :ref:`set up <setup>` and contribute a
patch:

1. :ref:`Get the source code <checkout>`::
1. Set up and install dependencies.

Install :ref:`Mercurial <vcsetup>` and other dependencies.

The dependencies needed will depend on the platform you're on.
Go to :ref:`Get Setup <setup>` page for detailed information.

2. :ref:`Get the source code <checkout>`::

hg clone https://hg.python.org/cpython

See :ref:`version control setup <vcsetup>` for installing Mercurial.

2. :ref:`Build Python <compiling>`. On all platforms, install build
dependencies (such as compilers). On :ref:`UNIX <unix-compiling>`
(including Mac OS X)::
3. Build Python.

Detailed information can be found :ref:`here <compiling>`.
There are different instructions for :ref:`UNIX <unix-compiling>`,
:ref:`Mac OS <MacOS>`, and :ref:`Windows <windows-compiling>`.

The command to compile on UNIX is::

./configure
make -j2

On some Mac OS:::

./configure --with-pydebug && make -j2
CPPFLAGS="-I$(brew --prefix openssl)/include" \
LDFLAGS="-L$(brew --prefix openssl)/lib" \
./configure --with-pydebug

On :ref:`Windows <windows-compiling>`::
On Windows:::

PCbuild\build.bat -e -d

If the build outputs warnings or errors, :ref:`build-dependencies` provides
detail on standard library extensions that depend on installing third-party
libraries for some operating systems.

3. :doc:`Run the tests <runtests>`::
4. :doc:`Run the tests <runtests>`::

./python -m test -j3
./python -m test -j3

On :ref:`most <mac-python.exe>` Mac OS X systems, replace :file:`./python`
with :file:`./python.exe`. On Windows, use :file:`python.bat` or
check the :ref:`Windows instructions <win-python.exe>`. With Python 2.7,
replace ``test`` with ``test.regrtest``.
4. Make the :doc:`patch <patch>`.
5. Submit it to the `issue tracker`_.
5. Make the :doc:`patch <patch>`.
6. Submit it to the `issue tracker`_.


Quick Links
Expand Down
2 changes: 2 additions & 0 deletions setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ dependencies for the Python version that you're working on e.g.::
If that package is not available for your system, try reducing the minor
version until you find a package that is available.

.. _MacOS:

On **Mac OS X systems**, use the C compiler and other
development utilities provided by Apple's Xcode Developer Tools.
The Developer Tools are not shipped with OS X.
Expand Down

0 comments on commit 93a3531

Please sign in to comment.