Skip to content

Commit 79f8ddc

Browse files
Simpler installation to ~/.vim for Vim users (#489)
1 parent 36f61f8 commit 79f8ddc

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,6 @@ If you have been a vimmer for quite a while, just pick out the part you are inte
8585

8686
### Prerequisites
8787

88-
Make sure you have installed:
89-
90-
- **git**
91-
- **Vim** or **NeoVim**
92-
9388
The most recent Vim(NeoVim) version is recommended, for space-vim has been specifically optimized for Vim8 and NeoVim with respect to the startup time.
9489

9590
[chocolatey](https://chocolatey.org/) is an easy way to install software on Windows, tools like `fzf`, `rg`, `ag` are necessary to get you a full-featured space-vim.
@@ -98,6 +93,8 @@ The most recent Vim(NeoVim) version is recommended, for space-vim has been speci
9893

9994
### Linux and macOS
10095

96+
`/path/to/space-vim` may be `~/.vim` (Vim), `~/.config/nvіm` (Neovim), or elsewhere. Installing space-vim to the conventional Vim/Neovim install location mitigates the need for an extra symlink to where space-vim is installed.
97+
10198
#### one-line installer
10299

103100
```bash
@@ -121,14 +118,11 @@ The easist way is to download [`install.cmd`](https://raw.githubusercontent.com/
121118

122119
### Manual
123120

124-
Given git and Vim/NeoVim have been installed already:
125-
126121
1. Clone [space-vim](https://github.com/liuchengxu/space-vim):
127122

128-
`/path/to/space-vim` may be `~/.vim` or `~/.config/nvіm` if you so desire.
129123

130124
```bash
131-
$ git clone https://github.com/liuchengxu/space-vim.git /path/to/space-vim
125+
$ git clone https://github.com/liuchengxu/space-vim.git --single-branch /path/to/space-vim
132126
```
133127

134128
2. Install [vim-plug](https://github.com/junegunn/vim-plug#installation), refer to vim-plug installation section for more information:
@@ -147,13 +141,17 @@ Given git and Vim/NeoVim have been installed already:
147141
**Linux and macOS**
148142

149143
```bash
150-
# For Vim
144+
# **For Vim**
145+
# If space-vim not installed to ~/.vim/:
151146
$ ln -s /path/to/space-vim/init.vim ~/.vimrc
147+
# Copy init.spacevim for local customization
152148
$ cp /path/to/space-vim/init.spacevim ~/.spacevim
153149
$ vim -es +'PlugInstall' +qall
154150
155-
# For NeoVim
151+
# **For NeoVim**
152+
# If space-vim not installed to ~/.config/nvim/:
156153
$ ln -s /path/to/space-vim/init.vim ~/.config/nvim/init.vim
154+
# Copy init.spacevim for local customization
157155
$ cp /path/to/space-vim/init.spacevim ~/.spacevim
158156
$ nvim +'PlugInstall' +qall
159157
```

vimrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
init.vim

0 commit comments

Comments
 (0)