Skip to content

Commit

Permalink
Simpler installation to ~/.vim for Vim users (#489)
Browse files Browse the repository at this point in the history
  • Loading branch information
rene-descartes2021 authored May 22, 2022
1 parent 36f61f8 commit 79f8ddc
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,6 @@ If you have been a vimmer for quite a while, just pick out the part you are inte

### Prerequisites

Make sure you have installed:

- **git**
- **Vim** or **NeoVim**

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.

[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.
Expand All @@ -98,6 +93,8 @@ The most recent Vim(NeoVim) version is recommended, for space-vim has been speci

### Linux and macOS

`/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.

#### one-line installer

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

### Manual

Given git and Vim/NeoVim have been installed already:

1. Clone [space-vim](https://github.com/liuchengxu/space-vim):

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

```bash
$ git clone https://github.com/liuchengxu/space-vim.git /path/to/space-vim
$ git clone https://github.com/liuchengxu/space-vim.git --single-branch /path/to/space-vim
```

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

```bash
# For Vim
# **For Vim**
# If space-vim not installed to ~/.vim/:
$ ln -s /path/to/space-vim/init.vim ~/.vimrc
# Copy init.spacevim for local customization
$ cp /path/to/space-vim/init.spacevim ~/.spacevim
$ vim -es +'PlugInstall' +qall
# For NeoVim
# **For NeoVim**
# If space-vim not installed to ~/.config/nvim/:
$ ln -s /path/to/space-vim/init.vim ~/.config/nvim/init.vim
# Copy init.spacevim for local customization
$ cp /path/to/space-vim/init.spacevim ~/.spacevim
$ nvim +'PlugInstall' +qall
```
Expand Down
1 change: 1 addition & 0 deletions vimrc

0 comments on commit 79f8ddc

Please sign in to comment.