Skip to content

Commit

Permalink
Docs for Homebrew Python/MacVim
Browse files Browse the repository at this point in the history
This can't really be fixed on YCM's side since it's a system configuration
issue, but we can at least warn the user and provide him with information on how
to resolve this.

Fixes #18 (not really, but it's the best we can do).
  • Loading branch information
Valloric committed Feb 6, 2013
1 parent 6f10d7a commit 3feefce
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ Install YouCompleteMe with [Vundle][].
Install CMake. Preferably with [Homebrew][brew], but here's the [stand-alone
CMake installer][cmake-download].

_If_ you have installed a Homebrew Python and/or Homebrew MacVim, see the FAQ
for details.

_If_ you care about semantic completion for C-family languages, type in the
following commands in the console. If you don't, **skip this step**.

Expand Down Expand Up @@ -686,6 +689,13 @@ builds Vim. I recommend using [MacVim][]. Even if you don't like the MacVim GUI,
you can use the Vim binary that is inside the MacVim.app package (it's
`MacVim.app/Contents/MacOS/Vim`) and get the Vim console experience.

### I have a Homebrew Python and/or MacVim; can't compile/SIGABRT when starting

You should probably run `brew rm python; brew install python` to get the latest
fixes that should make YCM work with such a configuration. Also rebuild Macvim
then. If you still get problems with this, see [issue #18][issue18] for
suggestions.

### Why isn't YCM just written in plain VimScript, FFS?

Because of the identifier completion engine and subsequence-based filtering.
Expand Down Expand Up @@ -742,3 +752,4 @@ This software is licensed under the [GPL v3 license][gpl].
[listtoggle]: https://github.com/Valloric/ListToggle
[vim-build]: https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source
[tracker]: https://github.com/Valloric/YouCompleteMe/issues?state=open
[issue18]: https://github.com/Valloric/YouCompleteMe/issues/18

1 comment on commit 3feefce

@aaron-goshine
Copy link

@aaron-goshine aaron-goshine commented on 3feefce May 2, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Valloric this work nicely

Please sign in to comment.