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

Update Windows installation in README

Browse Source 
Add instructions for Python 3 on Windows. Change link to Vim builds
for Windows. Always use a capital letter for Python.
This commit is contained in:
micbou 2016-03-20 13:55:25 +01:00
parent 21a0019279
commit dbc2c08af9
2 changed files with 53 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -266,7 +266,7 @@ 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 or python3 support. Fedora 21 and Make sure you have Vim 7.3.598 with Python 2 or Python 3 support. Fedora 21 and
later have a Vim that's recent enough. You can see the version of Vim installed 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 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). Vim from source][vim-build] (don't worry, it's easy).
@ -329,11 +329,13 @@ 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 or python3 support. You can Make sure you have at least Vim 7.3.598 with Python 2 or Python 3 support. You
check the version by typing `:version` inside Vim. Take note of the Vim can check the version and which Python is supported by typing `:version` inside
architecture, i.e. 32 or 64-bit. It will be important when choosing the python2 Vim. Look at the features included: `+python/dyn` for Python 2 and
installer. We recommend using a 64-bit client. Don't worry, [a frequently `+python3/dyn` for Python 3. Take note of the Vim architecture, i.e. 32 or
updated copy of 64-bit Vim][vim64-win-download] is available. 64-bit. It will be important when choosing the Python installer. We recommend
using a 64-bit client. [Daily updated copies of 32-bit and 64-bit Vim with
Python 2 and Python 3 support][vim-win-download] are available.
Install YouCompleteMe with [Vundle][]. Install YouCompleteMe with [Vundle][].
@ -344,9 +346,9 @@ process.
Download and install the following software: Download and install the following software:
- [python3][python-win-download]. Be sure to pick the version corresponding to - [Python 2 or Python 3][python-win-download]. Be sure to pick the version
your Vim architecture. It is _Windows x86-64 MSI installer_ if you are using the corresponding to your Vim architecture. It is _Windows x86_ for a 32-bit Vim and
Vim previously linked. _Windows x86-64_ for a 64-bit Vim. We recommend installing Python 3.
- [CMake][cmake-download]. Add CMake executable to the PATH environment - [CMake][cmake-download]. Add CMake executable to the PATH environment
variable. variable.
- [Visual Studio][visual-studio-download]. Download the community edition. - [Visual Studio][visual-studio-download]. Download the community edition.
@ -404,7 +406,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 or python3 support. Make sure you have Vim 7.3.598 with Python 2 or Python 3 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`.
@ -481,7 +483,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 or python3 scripting**. support for Python 2 or Python 3 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
@ -497,7 +499,7 @@ process.
it's 0, then get a 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 python 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
@ -539,11 +541,12 @@ 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
python3-dev`. On Mac they should already be present. python3-dev`. On Mac they should already be present.
On Windows, you need to download and install [python3][python-win-download]. On Windows, you need to download and install [Python 2 or
Pick the version corresponding to your Vim architecture. You will also need Python 3][python-win-download]. Pick the version corresponding to your Vim
Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by installing architecture. You will also need Microsoft Visual C++ (MSVC) to build YCM.
[Visual Studio][visual-studio-download]. MSVC 11 (Visual Studio 2012), 12 You can obtain it by installing [Visual Studio][visual-studio-download].
(2013), and 14 (2015) are officially supported. MSVC 11 (Visual Studio 2012), 12 (2013), and 14 (2015) are officially
supported.
Here we'll assume you installed YCM with Vundle. That means that the Here we'll assume you installed YCM with Vundle. That means that the
top-level YCM directory is in `~/.vim/bundle/YouCompleteMe`. top-level YCM directory is in `~/.vim/bundle/YouCompleteMe`.
@ -939,10 +942,10 @@ 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+) 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
binary to use. For example, to provide Python 3 completion in your project, set: binary to use. For example, to provide Python 3 completion in your project, set:
```viml ```viml
@ -2307,8 +2310,8 @@ let g:ycm_disable_for_files_larger_than_kb = 1000
### The `g:ycm_python_binary_path` option ### The `g:ycm_python_binary_path` option
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][] runs on By default the Python under which [ycmd][] runs is used ([ycmd][] runs on
Python 2.6, 2.7 or 3.3+). Python 2.6, 2.7 or 3.3+).
Default: `''` Default: `''`
@ -2829,7 +2832,7 @@ This software is licensed under the [GPL v3 license][gpl].
[Godef]: https://github.com/Manishearth/godef [Godef]: https://github.com/Manishearth/godef
[TSServer]: https://github.com/Microsoft/TypeScript/tree/master/src/server [TSServer]: https://github.com/Microsoft/TypeScript/tree/master/src/server
[NeoBundle]: https://github.com/Shougo/neobundle.vim [NeoBundle]: https://github.com/Shougo/neobundle.vim
[vim64-win-download]: https://bintray.com/veegee/generic/vim_x64 [vim-win-download]: https://bintray.com/micbou/generic/vim
[python-win-download]: https://www.python.org/downloads/windows/ [python-win-download]: https://www.python.org/downloads/windows/
[visual-studio-download]: https://www.visualstudio.com/products/free-developer-offers-vs.aspx [visual-studio-download]: https://www.visualstudio.com/products/free-developer-offers-vs.aspx
[7z-download]: http://www.7-zip.org/download.html [7z-download]: http://www.7-zip.org/download.html

50
doc/youcompleteme.txt
View File

@ -461,7 +461,7 @@ Fedora Linux x64 ~
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 or python3 support. Fedora 21 and Make sure you have Vim 7.3.598 with Python 2 or Python 3 support. Fedora 21 and
later have a Vim that's recent enough. You can see the version of Vim installed 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 by running 'vim --version'. If the version is too old, you may need to compile
Vim from source [24] (don't worry, it's easy). Vim from source [24] (don't worry, it's easy).
@ -530,11 +530,13 @@ 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 or python3 support. You Make sure you have at least Vim 7.3.598 with Python 2 or Python 3 support. You
can check the version by typing ':version' inside Vim. Take note of the Vim can check the version and which Python is supported by typing ':version' inside
architecture, i.e. 32 or 64-bit. It will be important when choosing the python2 Vim. Look at the features included: '+python/dyn' for Python 2 and
installer. We recommend using a 64-bit client. Don't worry, a frequently '+python3/dyn' for Python 3. Take note of the Vim architecture, i.e. 32 or
updated copy of 64-bit Vim [25] is available. 64-bit. It will be important when choosing the Python installer. We recommend
using a 64-bit client. Daily updated copies of 32-bit and 64-bit Vim with
Python 2 and Python 3 support [25] are available.
Install YouCompleteMe with Vundle [19]. Install YouCompleteMe with Vundle [19].
@ -544,9 +546,9 @@ will notify you to recompile it. You should then rerun the install process.
Download and install the following software: Download and install the following software:
- python3 [26]. Be sure to pick the version corresponding to your Vim - Python 2 or Python 3 [26]. Be sure to pick the version corresponding to
architecture. It is _Windows x86-64 MSI installer_ if you are using the Vim your Vim architecture. It is _Windows x86_ for a 32-bit Vim and _Windows
previously linked. x86-64_ for a 64-bit Vim. We recommend installing Python 3.
- CMake [21]. Add CMake executable to the PATH environment variable. - CMake [21]. Add CMake executable to the PATH environment variable.
@ -611,7 +613,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 or python3 support. Make sure you have Vim 7.3.598 with Python 2 or Python 3 support.
OpenBSD 5.5 and later have a Vim that's recent enough. You can see the version OpenBSD 5.5 and later have a Vim that's recent enough. You can see the version
of Vim installed by running 'vim --version'. of Vim installed by running 'vim --version'.
@ -692,7 +694,7 @@ will notify you to recompile it. You should then rerun the install 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 or python3 scripting**. support for Python 2 or Python 3 scripting**.
Inside Vim, type ':version'. Look at the first two to three lines of 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 output; it should say 'Vi IMproved X.Y', where X.Y is the major version
@ -708,7 +710,7 @@ will notify you to recompile it. You should then rerun the install process.
If it's 0, then get a version of Vim with Python support. 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 On Windows, check also if your Vim architecture is 32 or 64-bit. This is
critical because it must match the python 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 [19] (or Pathogen [30], but Vundle is a 2. **Install YCM** with Vundle [19] (or Pathogen [30], but Vundle is a
@ -750,11 +752,11 @@ will notify you to recompile it. You should then rerun the install process.
a Debian-like Linux distro, this would be 'sudo apt-get install python- a Debian-like Linux distro, this would be 'sudo apt-get install python-
dev python3-dev'. On Mac they should already be present. dev python3-dev'. On Mac they should already be present.
On Windows, you need to download and install python3 [26]. Pick the On Windows, you need to download and install Python 2 or Python 3 [26].
version corresponding to your Vim architecture. You will also need Pick the version corresponding to your Vim architecture. You will also
Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by installing need Microsoft Visual C++ (MSVC) to build YCM. You can obtain it by
Visual Studio [27]. MSVC 11 (Visual Studio 2012), 12 (2013), and 14 installing Visual Studio [27]. MSVC 11 (Visual Studio 2012), 12 (2013),
(2015) are officially supported. and 14 (2015) are officially supported.
Here we'll assume you installed YCM with Vundle. That means that the top- Here we'll assume you installed YCM with Vundle. That means that the top-
level YCM directory is in '~/.vim/bundle/YouCompleteMe'. level YCM directory is in '~/.vim/bundle/YouCompleteMe'.
@ -1187,10 +1189,10 @@ Python Semantic Completion ~
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 [6] library which configuration. Those features are provided by the jedi [6] library which
supports a variety of python versions (2.6, 2.7, 3.2+) as long as it runs in 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 [6] with the the corresponding Python interpreter. By default YCM runs jedi [6] with the
same python interpreter used by the ycmd server [34], so if you would like to same Python interpreter used by the ycmd server [34], 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
binary to use. For example, to provide Python 3 completion in your project, binary to use. For example, to provide Python 3 completion in your project,
set: set:
> >
@ -2540,8 +2542,8 @@ Default: 1000
The *g:ycm_python_binary_path* option The *g:ycm_python_binary_path* option
This option specifies the Python interpreter to use to run the jedi [6] This option specifies the Python interpreter to use to run the jedi [6]
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 [34] runs is used (ycmd [34] runs on By default the Python under which ycmd [34] runs is used (ycmd [34] runs on
Python 2.6, 2.7 or 3.3+). Python 2.6, 2.7 or 3.3+).
Default: "''" Default: "''"
@ -3089,7 +3091,7 @@ References ~
[22] https://docs.npmjs.com/getting-started/installing-node [22] https://docs.npmjs.com/getting-started/installing-node
[23] https://www.rust-lang.org/ [23] https://www.rust-lang.org/
[24] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source [24] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source
[25] https://bintray.com/veegee/generic/vim_x64 [25] https://bintray.com/micbou/generic/vim
[26] https://www.python.org/downloads/windows/ [26] https://www.python.org/downloads/windows/
[27] https://www.visualstudio.com/products/free-developer-offers-vs.aspx [27] https://www.visualstudio.com/products/free-developer-offers-vs.aspx
[28] http://www.7-zip.org/download.html [28] http://www.7-zip.org/download.html