From 451c8df727db86da8a65af9a559889bfa38182be Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 4 Jul 2015 11:03:27 -0500 Subject: add some documentation around the requirement for xcode cli tools on mac --- docs/installation.rst | 15 ++++++++++++++- docs/spelling_wordlist.txt | 1 + 2 files changed, 15 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/installation.rst b/docs/installation.rst index 1c25ff78..c47e2d1d 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -125,8 +125,21 @@ You'll also need to generate your own ``openssl.ld`` file. For example:: You should replace the version string on the first line as appropriate for your build. +Building cryptography on OS X +----------------------------- + +To install the Xcode command line tools on OS X open a terminal window and run: + +.. code-block:: console + + $ xcode-select --install + +This will install a compiler (clang) along with the required development +headers. If you wish to compile against a more recent OpenSSL than the +version shipped with OS X see the next section. + Using your own OpenSSL on OS X ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To link cryptography against a custom version of OpenSSL you'll need to set ``ARCHFLAGS``, ``LDFLAGS``, and ``CFLAGS``. OpenSSL can be installed via diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 235e08d4..1eed7c7a 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -63,3 +63,4 @@ unpadded unpadding Verisign wildcard +Xcode -- cgit v1.2.3 From 47e1b6047efb72aab1fb9296dfd566f59440b752 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 4 Jul 2015 11:21:52 -0500 Subject: add some more detail. --- docs/installation.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/installation.rst b/docs/installation.rst index c47e2d1d..96e1e8de 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -128,7 +128,9 @@ build. Building cryptography on OS X ----------------------------- -To install the Xcode command line tools on OS X open a terminal window and run: +Building cryptography requires the presence of a C compiler and development +headers. On OS X this is typically provided by Apple's Xcode development tools. +To install the Xcode command line tools on open a terminal window and run: .. code-block:: console -- cgit v1.2.3