vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updating docs to state python3 support!

Browse Source
This commit is contained in:
Val Markovic 2016-02-28 17:45:41 -08:00
parent 8c0192ecf7
commit 3dbbfc3c25
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -203,10 +203,10 @@ that are conservatively turned off by default that you may want to turn on.
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
Make sure you have Vim 7.3.598 with python2 support. Ubuntu 14.04 and later have Make sure you have Vim 7.3.598 with python2 or python3 support. Ubuntu 14.04 and
a Vim that's recent enough. You can see the version of Vim installed by running later have a Vim that's recent enough. You can see the version of Vim installed
`vim --version`. If the version is too old, you may need to [compile Vim by running `vim --version`. If the version is too old, you may need to [compile
from source][vim-build] (don't worry, it's easy). Vim from source][vim-build] (don't worry, it's easy).
Install YouCompleteMe with [Vundle][]. Install YouCompleteMe with [Vundle][].
@ -261,10 +261,10 @@ that are conservatively turned off by default that you may want to turn on.
Please refer to the full Installation Guide below; the following commands are Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. provided on a best-effort basis and may not work for you.
Make sure you have Vim 7.3.598 with python2 support. Fedora 21 and later have Make sure you have Vim 7.3.598 with python2 or python3 support. Fedora 21 and
a Vim that's recent enough. You can see the version of Vim installed by running later have a Vim that's recent enough. You can see the version of Vim installed
`vim --version`. If the version is too old, you may need to [compile Vim by running `vim --version`. If the version is too old, you may need to [compile
from source][vim-build] (don't worry, it's easy). Vim from source][vim-build] (don't worry, it's easy).
Install YouCompleteMe with [Vundle][]. Install YouCompleteMe with [Vundle][].
@ -322,11 +322,11 @@ provided on a best-effort basis and may not work for you.
**Important:** we assume that you are using the `cmd.exe` command prompt and **Important:** we assume that you are using the `cmd.exe` command prompt and
that you know how to add an executable to the PATH environment variable. that you know how to add an executable to the PATH environment variable.
Make sure you have at least Vim 7.3.598 with python2 support. You can check the Make sure you have at least Vim 7.3.598 with python2 or python3 support. You can
version by typing `:version` inside Vim. Take note of the Vim architecture, i.e. check the version by typing `:version` inside Vim. Take note of the Vim
32 or 64-bit. It will be important when choosing the python2 installer. We architecture, i.e. 32 or 64-bit. It will be important when choosing the python2
recommend using a 64-bit client. Don't worry, [a frequently updated copy of installer. We recommend using a 64-bit client. Don't worry, [a frequently
64-bit Vim][vim64-win-download] is available. updated copy of 64-bit Vim][vim64-win-download] is available.
Install YouCompleteMe with [Vundle][]. Install YouCompleteMe with [Vundle][].
@ -337,7 +337,7 @@ process.
Download and install the following software: Download and install the following software:
- [python2][python-win-download]. Be sure to pick the version corresponding to - [python3][python-win-download]. Be sure to pick the version corresponding to
your Vim architecture. It is _Windows x86-64 MSI installer_ if you are using the your Vim architecture. It is _Windows x86-64 MSI installer_ if you are using the
Vim previously linked. Vim previously linked.
- [CMake][cmake-download]. Add CMake executable to the PATH environment - [CMake][cmake-download]. Add CMake executable to the PATH environment
@ -395,7 +395,7 @@ Please refer to the full Installation Guide below; the following commands are
provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are provided on a best-effort basis and may not work for you. OpenBSD / FreeBSD are
not officially supported platforms by YCM. not officially supported platforms by YCM.
Make sure you have Vim 7.3.598 with python2 support. Make sure you have Vim 7.3.598 with python2 or python3 support.
OpenBSD 5.5 and later have a Vim that's recent enough. You can see the version of OpenBSD 5.5 and later have a Vim that's recent enough. You can see the version of
Vim installed by running `vim --version`. Vim installed by running `vim --version`.
@ -471,7 +471,7 @@ process.
**Please follow the instructions carefully. Read EVERY WORD.** **Please follow the instructions carefully. Read EVERY WORD.**
1. **Ensure that your version of Vim is _at least_ 7.3.598 _and_ that it has 1. **Ensure that your version of Vim is _at least_ 7.3.598 _and_ that it has
support for python2 scripting**. support for python2 or python3 scripting**.
Inside Vim, type `:version`. Look at the first two to three lines of output; Inside Vim, type `:version`. Look at the first two to three lines of output;
it should say `Vi IMproved X.Y`, where X.Y is the major version of vim. If it should say `Vi IMproved X.Y`, where X.Y is the major version of vim. If
@ -483,11 +483,11 @@ process.
from source][vim-build] (don't worry, it's easy). from source][vim-build] (don't worry, it's easy).
After you have made sure that you have Vim 7.3.598+, type the following in After you have made sure that you have Vim 7.3.598+, type the following in
Vim: `:echo has('python')`. The output should be 1. If it's 0, then get a Vim: `:echo has('python') || has('python3')`. The output should be 1. If
version of Vim with Python support. it's 0, then get a version of Vim with Python support.
On Windows, check also if your Vim architecture is 32 or 64-bit. This is On Windows, check also if your Vim architecture is 32 or 64-bit. This is
critical because it must match the python2 and the YCM libraries critical because it must match the python and the YCM libraries
architectures. We recommend using a 64-bit Vim. architectures. We recommend using a 64-bit Vim.
2. **Install YCM** with [Vundle][] (or [Pathogen][], but Vundle is a better 2. **Install YCM** with [Vundle][] (or [Pathogen][], but Vundle is a better
@ -529,7 +529,7 @@ process.
Debian-like Linux distro, this would be `sudo apt-get install python-dev`. Debian-like Linux distro, this would be `sudo apt-get install python-dev`.
On Mac they should already be present. On Mac they should already be present.
On Windows, you need to download and install [python2][python-win-download]. On Windows, you need to download and install [python3][python-win-download].
Pick the version corresponding to your Vim architecture. You will also need Pick the version corresponding to your Vim architecture. You will also need
Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by installing Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by installing
[Visual Studio][visual-studio-download]. MSVC 11 (Visual Studio 2012), 12 [Visual Studio][visual-studio-download]. MSVC 11 (Visual Studio 2012), 12
@ -929,7 +929,7 @@ let g:ycm_rust_src_path = '/usr/local/rust/rustc-1.5.0/src'
Completion and GoTo commands work out of the box with no additional Completion and GoTo commands work out of the box with no additional
configuration. Those features are provided by the [jedi][] library which configuration. Those features are provided by the [jedi][] library which
supports a variety of python versions (2.6, 2.7, 3.2, 3.3 or 3.4) as long as it supports a variety of python versions (2.6, 2.7, 3.2+) as long as it
runs in the corresponding python interpreter. By default YCM runs [jedi][] with runs in the corresponding python interpreter. By default YCM runs [jedi][] with
the same python interpreter used by the [ycmd server][ycmd], so if you would like to the same python interpreter used by the [ycmd server][ycmd], so if you would like to
use a different interpreter, use the following option specifying the python use a different interpreter, use the following option specifying the python
@ -2298,8 +2298,8 @@ let g:ycm_disable_for_files_larger_than_kb = 1000
This option specifies the Python interpreter to use to run the [jedi][] This option specifies the Python interpreter to use to run the [jedi][]
completion library. Specify the python interpreter to use to get completions. completion library. Specify the python interpreter to use to get completions.
By default the python under which [ycmd][] runs is used ([ycmd][] only runs By default the python under which [ycmd][] runs is used ([ycmd][] runs on
under Python 2.6 or 2.7). Python 2.6, 2.7 or 3.3+).
Default: `''` Default: `''`
@ -2719,10 +2719,10 @@ EOF
### I hear that YCM only supports Python 2, is that true? ### I hear that YCM only supports Python 2, is that true?
No. The Vim client and the [ycmd server][ycmd] only run under Python 2 but if **No.** Both the Vim client and the [ycmd server][ycmd] run on Python 2 or 3. If
you work on a Python 3 project then just set the `g:ycm_python_binary_path` to you work on a Python 3 project, you may need to set `g:ycm_python_binary_path`
the Python interpreter you use for your project and you will get completions for to the Python interpreter you use for your project to get completions for that
that version of Python. version of Python.
Contributor Code of Conduct Contributor Code of Conduct
--------------------------- ---------------------------