You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-87Lines changed: 21 additions & 87 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,38 +85,19 @@ If you have been a vimmer for quite a while, just pick out the part you are inte
85
85
86
86
### Prerequisites
87
87
88
-
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.
88
+
The most recent Vim(NeoVim) version is recommended.
89
89
90
-
[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.
90
+
space-vim aspires to adhere to the zero-install philosophy, just clone and use. Optional dependencies not installed on the system are downloaded and built from source where possible, and are used embedded within the application.
91
91
92
-
:exclamation:~~When layers enabled at the first time, you need to run `:PlugInstall` to install relevant plugins~~.
92
+
> In order to make a project zero-install, you must be able to use it as soon as you clone it.
93
93
94
-
### Linux and macOS
94
+
At present there is a lack of the above dependency build feature on Windows. [chocolatey](https://chocolatey.org/) is an easy way to install software on Windows, tools like `fzf`, `rg`, `ag`, `rustc`, `cargo`, `npm` are necessary to get you a full-featured space-vim.
95
95
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.
96
+
### Install location
97
97
98
-
#### one-line installer
98
+
Installing space-vim to the conventional Vim/Neovim install location mitigates the need for an extra symlink to where space-vim is installed. `/path/to/space-vim` may be `~/.vim` (Vim), `~/.config/nvіm` (Neovim), or elsewhere.
The easist way is to download [`install.cmd`](https://raw.githubusercontent.com/liuchengxu/space-vim/master/install.cmd) and **run it as administrator**, or [install space-vim manually](https://github.com/liuchengxu/space-vim/wiki/install#windows).
You can use `.spacevim`in your home directory to customize space-vim, where you can enable the existing layers, add your extra plugins and private configurations.
162
121
163
-
If `.spacevim` does not exist, vanilla vim will be loaded! Refer to [init.spacevim](init.spacevim) as an example.
164
122
165
-
### Presetting
166
123
167
-
```vim
168
-
" Comment the following line if you don't want Vim and NeoVim to share the
169
-
" same plugin download directory.
170
-
let g:spacevim_plug_home = '~/.vim/plugged'
171
-
172
-
" Uncomment the following line to override the leader key. The default value is space key "<\Space>".
173
-
"let g:spacevim_leader = "<\Space>"
174
-
175
-
" Uncomment the following line to override the local leader key. The default value is comma ','.
176
-
"let g:spacevim_localleader = ','
124
+
## Customize
177
125
178
-
" Enable the existing layers in space-vim
179
-
" Refer to https://github.com/liuchengxu/space-vim/blob/master/layers/LAYERS.md for all available layers.
180
-
let g:spacevim_layers = [
181
-
\ 'fzf', 'better-defaults', 'which-key',
182
-
\ ]
126
+
```bash
127
+
# Copy init.spacevim for local customization, or symlink it
128
+
$ cp /path/to/space-vim/init.spacevim ~/.spacevim
129
+
```
183
130
184
-
" Uncomment the following line if your terminal(-emulator) supports true colors.
185
-
"let g:spacevim_enable_true_color = 1
131
+
You can use `.spacevim`in your home directory to customize space-vim, where you can enable the existing layers, add your extra plugins and private configurations.
186
132
187
-
" Uncomment the following if you have some nerd font installed.
188
-
"let g:spacevim_nerd_fonts = 1
189
-
190
-
" If you want to have more control over the layer, try using Layer command.
191
-
"if g:spacevim.gui
192
-
" Layer 'airline'
193
-
" endif
194
-
```
133
+
### .spacevim details
195
134
196
135
Please refer to [LAYERS.md](layers/LAYERS.md) to take a look at the whole shipped layers.
197
136
198
137
Basically, `g:spacevim_layers` almost takes the place of `Layer` command. As far as I known, most people never use the option of `Layer` command, e.g., `exclude`, so `g:spacevim_layers` could save a lengthy `Layer` list, requiring less ceremony. Nevertheless, `Layer`command is still avaiable for some advanced uses.
199
138
200
139
### `UserInit()`
201
140
141
+
`UserInit()` may be used to add plugins that are not within a layer.
142
+
202
143
```vim
203
144
" Manage your own plugins.
204
-
" Refer to https://github.com/junegunn/vim-plugfor more detials.
145
+
" Refer to https://github.com/Shougo/dein.vim for more detials.
205
146
function!UserInit()
206
147
207
-
" Add your own plugin via Plug command.
148
+
" Add your own plugin via Plug command (wrapper around dein#add)
208
149
Plug 'junegunn/seoul256.vim'
209
150
210
151
endfunction
211
152
```
212
153
213
154
### `UserConfig()`
214
155
156
+
Configuration may be placed in`UserConfig()`, and/or in a `plugin/` folder on the runtime path. E.g. `~/.vim/plugin/<pluginname>.vim`for each local plugin configuration.
157
+
215
158
```vim
216
159
" Override the default settings as well as adding extras
217
160
function!UserConfig()
@@ -289,15 +232,6 @@ Second, since console Vim uses whatever font the console/terminal is using, you'
289
232
290
233
## Update
291
234
292
-
Run `make update`:
293
-
294
-
```bash
295
-
$ cd path/to/space-vim
296
-
$ make update
297
-
```
298
-
299
-
Alternatively, you can manually perform the following steps. If anything has changed with the structure of the configuration, you will have to create the appropriate symlinks.
0 commit comments