Updating docs to state python3 support!
This commit is contained in:
Val Markovic
parent
8c0192ecf7
commit
3dbbfc3c25
54
README.md
54
README.md
@ -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
|
||||
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
|
||||
a Vim that's recent enough. You can see the version of Vim installed by running
|
||||
`vim --version`. If the version is too old, you may need to [compile Vim
|
||||
from source][vim-build] (don't worry, it's easy).
|
||||
Make sure you have Vim 7.3.598 with python2 or python3 support. Ubuntu 14.04 and
|
||||
later have a Vim that's recent enough. You can see the version of Vim installed
|
||||
by running `vim --version`. If the version is too old, you may need to [compile
|
||||
Vim from source][vim-build] (don't worry, it's easy).
|
||||
|
||||
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
|
||||
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
|
||||
a Vim that's recent enough. You can see the version of Vim installed by running
|
||||
`vim --version`. If the version is too old, you may need to [compile Vim
|
||||
from source][vim-build] (don't worry, it's easy).
|
||||
Make sure you have Vim 7.3.598 with python2 or python3 support. Fedora 21 and
|
||||
later have a Vim that's recent enough. You can see the version of Vim installed
|
||||
by running `vim --version`. If the version is too old, you may need to [compile
|
||||
Vim from source][vim-build] (don't worry, it's easy).
|
||||
|
||||
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
|
||||
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
|
||||
version by typing `:version` inside Vim. Take note of the Vim architecture, i.e.
|
||||
32 or 64-bit. It will be important when choosing the python2 installer. We
|
||||
recommend using a 64-bit client. Don't worry, [a frequently updated copy of
|
||||
64-bit Vim][vim64-win-download] is available.
|
||||
Make sure you have at least Vim 7.3.598 with python2 or python3 support. You can
|
||||
check the version by typing `:version` inside Vim. Take note of the Vim
|
||||
architecture, i.e. 32 or 64-bit. It will be important when choosing the python2
|
||||
installer. We recommend using a 64-bit client. Don't worry, [a frequently
|
||||
updated copy of 64-bit Vim][vim64-win-download] is available.
|
||||
|
||||
Install YouCompleteMe with [Vundle][].
|
||||
|
||||
@ -337,7 +337,7 @@ process.
|
||||
|
||||
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
|
||||
Vim previously linked.
|
||||
- [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
|
||||
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
|
||||
Vim installed by running `vim --version`.
|
||||
@ -471,7 +471,7 @@ process.
|
||||
**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
|
||||
support for python2 scripting**.
|
||||
support for python2 or python3 scripting**.
|
||||
|
||||
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
|
||||
@ -483,11 +483,11 @@ process.
|
||||
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
|
||||
Vim: `:echo has('python')`. The output should be 1. If it's 0, then get a
|
||||
version of Vim with Python support.
|
||||
Vim: `:echo has('python') || has('python3')`. The output should be 1. If
|
||||
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
|
||||
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.
|
||||
|
||||
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`.
|
||||
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
|
||||
Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by installing
|
||||
[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
|
||||
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
|
||||
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
|
||||
@ -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][]
|
||||
completion library. Specify the python interpreter to use to get completions.
|
||||
By default the python under which [ycmd][] runs is used ([ycmd][] only runs
|
||||
under Python 2.6 or 2.7).
|
||||
By default the python under which [ycmd][] runs is used ([ycmd][] runs on
|
||||
Python 2.6, 2.7 or 3.3+).
|
||||
|
||||
Default: `''`
|
||||
|
||||
@ -2719,10 +2719,10 @@ EOF
|
||||
|
||||
### 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
|
||||
you work on a Python 3 project then just set the `g:ycm_python_binary_path` to
|
||||
the Python interpreter you use for your project and you will get completions for
|
||||
that version of Python.
|
||||
**No.** Both the Vim client and the [ycmd server][ycmd] run on Python 2 or 3. If
|
||||
you work on a Python 3 project, you may need to set `g:ycm_python_binary_path`
|
||||
to the Python interpreter you use for your project to get completions for that
|
||||
version of Python.
|
||||
|
||||
Contributor Code of Conduct
|
||||
---------------------------
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user