Skip to content

Commit 135a332

Browse files
authored
Improve OSX install documentation
1 parent 69d078e commit 135a332

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/install.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ Install pygit2:
161161
.. code-block:: sh
162162
163163
$ export LDFLAGS="-Wl,-rpath='$LIBGIT2/lib',--enable-new-dtags $LDFLAGS"
164+
# on OSX: export LDFLAGS="-Wl,-rpath,'$LIBGIT2/lib' $LDFLAGS"
164165
$ pip install pygit2
165166
$ python -c 'import pygit2'
166167
@@ -197,7 +198,9 @@ Installing on Windows
197198
`pygit2` for Windows is packaged into wheels and can be easily
198199
installed with `pip`:
199200

200-
pip install pygit2
201+
.. code-block:: console
202+
203+
pip install pygit2
201204
202205
For development it is also possible to build `pygit2` with `libgit2`
203206
from sources. `libgit2` location is specified by the ``LIBGIT2``
@@ -238,3 +241,5 @@ XCode and Hombrew are already installed.
238241
$ brew update
239242
$ brew install libgit2
240243
$ pip3 install pygit2
244+
245+
To build from a non-Homebrew libgit2 follow the guide in `libgit2 within a virtual environment`_.

0 commit comments

Comments
 (0)