8000 Made "install dependencies" as Step number one. (#37) · matrixise/devguide@93a3531 · GitHub
[go: up one dir, main page]

Skip to content

Commit 93a3531

Browse files
Mariattancoghlan
authored andcommitted
Made "install dependencies" as Step number one. (python#37)
1 parent 9adca02 commit 93a3531

File tree

2 files changed

+30
-11
lines changed

2 files changed

+30
-11
lines changed

index.rst

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,53 @@ Quick Start
1414
Here are the basic steps needed to get :ref:`set up <setup>` and contribute a
1515
patch:
1616

17-
1. :ref:`Get the source code <checkout>`::
17+
1. Set up and install dependencies.
18+
19+
Install :ref:`Mercurial <vcsetup>` and other dependencies.
20+
21+
The dependencies needed will depend on the platform you're on.
22+
Go to :ref:`Get Setup <setup>` page for detailed information.
23+
24+
2. :ref:`Get the source code <checkout>`::
1825

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

21-
See :ref:`version control setup <vcsetup>` for installing Mercurial.
22< 8000 /code>28

23-
2. :ref:`Build Python <compiling>`. On all platforms, install build
24-
dependencies (such as compilers). On :ref:`UNIX <unix-compiling>`
25-
(including Mac OS X)::
29+
3. Build Python.
30+
31+
Detailed information can be found :ref:`here <compiling>`.
32+
There are different instructions for :ref:`UNIX <unix-compiling>`,
33+
:ref:`Mac OS <MacOS>`, and :ref:`Windows <windows-compiling>`.
34+
35+
The command to compile on UNIX is::
36+
37+
./configure
38+
make -j2
39+
40+
On some Mac OS:::
2641

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

29-
On :ref:`Windows <windows-compiling>`::
46+
On Windows:::
3047

3148
PCbuild\build.bat -e -d
3249

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

37-
3. :doc:`Run the tests <runtests>`::
54+
4. :doc:`Run the tests <runtests>`::
3855

39-
./python -m test -j3
56+
./python -m test -j3
4057

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

4865

4966
Quick Links

setup.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ dependencies for the Python version that you're working on e.g.::
126126
If that package is not available for your system, try reducing the minor
127127
version until you find a package that is available.
128128

129+
.. _MacOS:
130+
129131
On **Mac OS X systems**, use the C compiler and other
130132
development utilities provided by Apple's Xcode Developer Tools.
131133
The Developer Tools are not shipped with OS X.

0 commit comments

Comments
 (0)
0