diff options
author | Andy Russell <arussell123@gmail.com> | 2018-04-20 13:04:30 -0400 |
---|---|---|
committer | Justin M. Keyes <justinkz@gmail.com> | 2018-04-20 19:04:30 +0200 |
commit | d29c243bef1297ae9b044616b894538e983ff9bc (patch) | |
tree | ca51002ad8a225505c9cab1f717bf328bc453b5f | |
parent | be1448213c7336c1be4c510f7f45c174d3a3b8c1 (diff) | |
download | rneovim-d29c243bef1297ae9b044616b894538e983ff9bc.tar.gz rneovim-d29c243bef1297ae9b044616b894538e983ff9bc.tar.bz2 rneovim-d29c243bef1297ae9b044616b894538e983ff9bc.zip |
doc: platform-specific config locations (#8297)
Fixes #7374.
-rw-r--r-- | runtime/doc/nvim.txt | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/runtime/doc/nvim.txt b/runtime/doc/nvim.txt index 2420227f6c..b8a481a016 100644 --- a/runtime/doc/nvim.txt +++ b/runtime/doc/nvim.txt @@ -20,15 +20,24 @@ differences from Vim. ============================================================================== Transitioning from Vim *nvim-from-vim* -To start the transition, create ~/.config/nvim/init.vim with these contents: +To start the transition, create init.vim in the correct directory for your +platform. + +For Linux, macOS and other Unixes, create the file at ~/.config/nvim/init.vim. + +For Windows, create the file at %LOCALAPPDATA%\nvim\init.vim. `%LOCALAPPDATA%` +usually expands to `C:\Users\<username>\AppData\Local`. + +Note: If your system sets `$XDG_CONFIG_HOME`, use that instead of `~/.config` +or `%LOCALAPPDATA%` in the paths above. Nvim follows the XDG |base-directories| +convention. + +Next, add these contents to the file: > set runtimepath^=~/.vim runtimepath+=~/.vim/after let &packpath = &runtimepath source ~/.vimrc < -Note: If your system sets `$XDG_CONFIG_HOME`, use that instead of `~/.config` -in the code above. Nvim follows the XDG |base-directories| convention. - See |provider-python| and |provider-clipboard| for additional software you might need to use some features. |