1********************
2Installation on OS X
3********************
4
5Python package
6==============
7
81. Install a proper Python version (see `issue #39
9   <https://github.com/powerline/powerline/issues/39>`_ for a discussion
10   regarding the required Python version on OS X)::
11
12       sudo port select python python27-apple
13
14   Homebrew may be used here::
15
16       brew install python
17
18   .. note::
19      In case :file:`powerline.sh` as a client ``socat`` and ``coreutils`` need
20      to be installed. ``coreutils`` may be installed using ``brew install
21      coreutils``.
22
232. Install Powerline using one of the following commands:
24
25   .. code-block:: sh
26
27       pip install --user powerline-status
28
29   will get current release version and
30
31   .. code-block:: sh
32
33       pip install --user git+git://github.com/powerline/powerline
34
35   will get latest development version.
36
37   .. warning::
38      When using ``brew install`` to install Python one must not supply
39      ``--user`` flag to ``pip``.
40
41   .. note::
42      Due to the naming conflict with an unrelated project powerline is named
43      ``powerline-status`` in PyPI.
44
45   .. note::
46      Powerline developers should be aware that ``pip install --editable`` does
47      not currently fully work. Installation performed this way are missing
48      ``powerline`` executable that needs to be symlinked. It will be located in
49      ``scripts/powerline``.
50
51Vim installation
52================
53
54Any terminal vim version with Python 3.2+ or Python 2.6+ support should work,
55but MacVim users need to install it using the following command::
56
57    brew install macvim --env-std --with-override-system-vim
58
59Fonts installation
60==================
61
62To install patched font double-click the font file in Finder, then click
63:guilabel:`Install this font` in the preview window.
64
65After installing the patched font MacVim or terminal emulator (whatever
66application powerline should work with) need to be configured to use the patched
67font. The correct font usually ends with *for Powerline*.
68